@radiantearth/stac-migrate 2.1.0 → 2.2.0

package/README.md

@@ -57,6 +57,10 @@ The commands follow the different methods above and has the same "restrictions"
 
   _A non-standalone Collection (with `child`/`item` links) migrated on its own drops its shared `properties`; pass the Items via `Migrate.item(item, collection)` to keep them._
 
+- Contacts 1.0.1
+
+  _Migrates from 0.1.0 onwards. The structure of 0.0.1 is not converted._
+
 - Data Cube 2.3.0
 
   _A `cube:dimensions` `reference_system` given as a PROJ4 or WKT string is not converted to the 2.0.0 representation._
@@ -70,7 +74,7 @@ The commands follow the different methods above and has the same "restrictions"
 
   _`file:nodata` maps to the single-valued `nodata` (first value kept); extra values are copied to a non-standard `nodata:values`._
 
-- Instruments 0.1.0
+- Instruments 0.2.0
 - Item Asset Definition 1.0.0 (legacy)
 - Label 1.0.1
 - Order 1.1.0
@@ -78,15 +82,30 @@ The commands follow the different methods above and has the same "restrictions"
 
   _`pc:encoding` is not rewritten and left in place._
 
-- Processing 1.2.0
-- Product 1.0.0
-- Projection 2.0.0
+- Processing 1.3.0
+- Product 1.1.0
+
+  _The deprecated `product:status` value `qualitydegraded` becomes `accepted` with `product:quality_status` set to `degraded`._
+
+- Projection 2.1.0
 - Raster 2.0.0
 - SAR 1.3.2
 - Satellite 1.2.0
 - Scientific Citation 1.0.0
+- Sentinel-1 0.2.0
+
+  _`s1:resolution`, `s1:product_identifier` and `s1:product_timeliness` are not migrated, as they have no 1:1 replacement._
+
+- Sentinel-3 0.2.0
+
+  _`s3:product_name`, `s3:processing_timeliness`, `s3:lrm_mode`, `s3:sar_mode` and the `s3:gsd` objects are not migrated, as they have no 1:1 replacement._
+
+- Sentinel-5P 0.2.0
+
+  _`s5p:product_name`, `s5p:spatial_resolution` and the product-specific objects are not migrated, as they have no 1:1 replacement._
+
 - Single Item
-- Table 1.2.0
+- Table 1.3.0
 - Timestamps 1.1.0
 - Versioning Indicators 1.2.0
 - View Geometry 1.1.0

package/migrate.js

@@ -9,26 +9,47 @@ const DONE = true; // This is used to verify in code coverage whether something
 const SCHEMAS = {
   cf: 'https://stac-extensions.github.io/cf/v1.0.0/schema.json',
   classification: 'https://stac-extensions.github.io/classification/v2.0.0/schema.json',
+  contacts: 'https://stac-extensions.github.io/contacts/v1.0.1/schema.json',
   datacube: 'https://stac-extensions.github.io/datacube/v2.3.0/schema.json',
   eo: 'https://stac-extensions.github.io/eo/v2.0.0/schema.json',
   file: 'https://stac-extensions.github.io/file/v2.1.0/schema.json',
-  instruments: 'https://stac-extensions.github.io/instruments/v0.1.0/schema.json',
+  instruments: 'https://stac-extensions.github.io/instruments/v0.2.0/schema.json',
   'item-assets': 'https://stac-extensions.github.io/item-assets/v1.0.0/schema.json',
   label: 'https://stac-extensions.github.io/label/v1.0.1/schema.json',
   order: 'https://stac-extensions.github.io/order/v1.1.0/schema.json',
   pointcloud: 'https://stac-extensions.github.io/pointcloud/v2.0.0/schema.json',
-  processing: 'https://stac-extensions.github.io/processing/v1.2.0/schema.json',
-  product: 'https://stac-extensions.github.io/product/v1.0.0/schema.json',
-  projection: 'https://stac-extensions.github.io/projection/v2.0.0/schema.json',
+  processing: 'https://stac-extensions.github.io/processing/v1.3.0/schema.json',
+  product: 'https://stac-extensions.github.io/product/v1.1.0/schema.json',
+  projection: 'https://stac-extensions.github.io/projection/v2.1.0/schema.json',
   raster: 'https://stac-extensions.github.io/raster/v2.0.0/schema.json',
   sar: 'https://stac-extensions.github.io/sar/v1.3.2/schema.json',
   sat: 'https://stac-extensions.github.io/sat/v1.2.0/schema.json',
   scientific: 'https://stac-extensions.github.io/scientific/v1.0.0/schema.json',
-  table: 'https://stac-extensions.github.io/table/v1.2.0/schema.json',
+  'sentinel-1': 'https://stac-extensions.github.io/sentinel-1/v0.2.0/schema.json',
+  'sentinel-3': 'https://stac-extensions.github.io/sentinel-3/v0.2.0/schema.json',
+  'sentinel-5p': 'https://stac-extensions.github.io/sentinel-5p/v0.2.0/schema.json',
+  table: 'https://stac-extensions.github.io/table/v1.3.0/schema.json',
   timestamps: 'https://stac-extensions.github.io/timestamps/v1.1.0/schema.json',
   version: 'https://stac-extensions.github.io/version/v1.2.0/schema.json',
   view: 'https://stac-extensions.github.io/view/v1.1.0/schema.json',
 };
+const S3_STATISTICS = [
+  'bright',
+  'closed_sea',
+  'coastal',
+  'continental_ice',
+  'cosmetic',
+  'dubious_samples',
+  'duplicated',
+  'fresh_inland_water',
+  'invalid',
+  'land',
+  'open_ocean',
+  'out_of_range',
+  'saline_water',
+  'saturated',
+  'tidal_region',
+];
 const EXTENSIONS = {
   // Add a : at the end to indicate it has a prefix, otherwise list all fields separately (see version extension for example).
   itemAndCollection: {
@@ -37,6 +58,7 @@ const EXTENSIONS = {
     'cube:': SCHEMAS.datacube,
     'eo:': SCHEMAS.eo,
     'file:': SCHEMAS.file,
+    'instrument:': SCHEMAS.instruments,
     'label:': SCHEMAS.label,
     'pc:': SCHEMAS.pointcloud,
     'processing:': SCHEMAS.processing,
@@ -806,7 +828,10 @@ var Band = {
       }
     }
 
-    if (V.before('1.1.0-beta.1') && (Array.isArray(obj['raster:bands']) || Array.isArray(obj['eo:bands']))) {
+    if (
+      (Array.isArray(obj['raster:bands']) || Array.isArray(obj['eo:bands'])) &&
+      (V.before('1.1.0-beta.1') || V.before('2.0.0-beta.1', 'raster') || V.before('2.0.0-beta.1', 'eo'))
+    ) {
       _.ensure(obj, 'bands', []);
 
       const raster = obj['raster:bands'] || [];
@@ -928,6 +953,12 @@ var Fields = {
     _.upgradeExtension(context, SCHEMAS.cf);
   },
 
+  contacts(obj, context) {
+    _.forAll(obj, 'contacts', (c) => _.isObject(c) && _.rename(c, 'positionName', 'position')) && DONE;
+
+    _.upgradeExtension(context, SCHEMAS.contacts);
+  },
+
   cube(obj, context) {
     // We'd need to convert proj strings to something else for v1.0 -> v2.0, but that's unfeasible here.
     // Nothing else to do here.
@@ -975,6 +1006,12 @@ var Fields = {
     _.upgradeExtension(context, SCHEMAS.file);
   },
 
+  instruments(obj, context) {
+    _.rename(obj, 'instrument_modes', 'instrument:modes') && _.addExtension(context, SCHEMAS.instruments) && DONE;
+
+    _.upgradeExtension(context, SCHEMAS.instruments);
+  },
+
   label(obj, context) {
     // Migrate 0.8.0-rc1 non-pluralized forms
     if (V.before('0.8.0')) {
@@ -1012,8 +1049,18 @@ var Fields = {
     _.upgradeExtension(context, SCHEMAS.processing);
   },
 
-  product(obj, context) {
-    // Nothing to do
+  product(obj, context, summaries) {
+    const status = obj['product:status'];
+    if (status === 'qualitydegraded' && !_.isDefined(obj['product:quality_status'])) {
+      obj['product:status'] = 'accepted';
+      obj['product:quality_status'] = 'degraded';
+      DONE;
+    } else if (summaries && Array.isArray(status) && status.includes('qualitydegraded')) {
+      obj['product:status'] = [...new Set(status.map((s) => (s === 'qualitydegraded' ? 'accepted' : s)))];
+      _.ensure(obj, 'product:quality_status', []);
+      !obj['product:quality_status'].includes('degraded') && obj['product:quality_status'].push('degraded');
+      DONE;
+    }
 
     _.upgradeExtension(context, SCHEMAS.product);
   },
@@ -1067,8 +1114,8 @@ var Fields = {
 
     _.rename(obj, 'sar:product_type', 'product:type') && _.addExtension(context, SCHEMAS.product) && DONE;
 
-    if (_.rename(obj, 'sar:instrument_mode', 'instrument_modes')) {
-      !summary && _.toArray(obj, 'instrument_modes');
+    if (_.rename(obj, 'sar:instrument_mode', 'instrument:modes')) {
+      !summary && _.toArray(obj, 'instrument:modes');
       _.addExtension(context, SCHEMAS.instruments) && DONE;
     }
 
@@ -1087,6 +1134,53 @@ var Fields = {
     _.upgradeExtension(context, SCHEMAS.sat);
   },
 
+  s1(obj, context) {
+    _.rename(obj, 's1:processing_datetime', 'processing:datetime') &&
+      _.addExtension(context, SCHEMAS.processing) &&
+      DONE;
+    _.rename(obj, 's1:processing_level', 'processing:level') &&
+      _.mapValues(obj, 'processing:level', ['0', '1', '2'], ['L0', 'L1', 'L2']) &&
+      _.addExtension(context, SCHEMAS.processing) &&
+      DONE;
+    _.rename(obj, 's1:shape', 'proj:shape') && _.addExtension(context, SCHEMAS.projection) && DONE;
+
+    _.upgradeExtension(context, SCHEMAS['sentinel-1']);
+  },
+
+  s3(obj, context, summaries) {
+    _.rename(obj, 's3:product_type', 'product:type') && _.addExtension(context, SCHEMAS.product) && DONE;
+    _.rename(obj, 's3:snow_or_ice', 'eo:snow_cover') && _.addExtension(context, SCHEMAS.eo) && DONE;
+
+    // Only the numeric GSD maps to gsd, the GSD objects of the other products are ambiguous
+    const gsd = obj['s3:gsd'];
+    if (_.is(gsd, 'number') || (summaries && Array.isArray(gsd) && gsd.every((v) => _.is(v, 'number')))) {
+      _.rename(obj, 's3:gsd', 'gsd') && DONE;
+    }
+
+    if (!summaries) {
+      for (let key of S3_STATISTICS) {
+        let oldKey = 's3:' + key;
+        if (_.is(obj[oldKey], 'number')) {
+          _.ensure(obj, 'statistics', {});
+          if (!_.isDefined(obj.statistics[key])) {
+            obj.statistics[key] = obj[oldKey];
+            delete obj[oldKey];
+            DONE;
+          }
+        }
+      }
+    }
+
+    _.upgradeExtension(context, SCHEMAS['sentinel-3']);
+  },
+
+  s5p(obj, context) {
+    _.rename(obj, 's5p:product_type', 'product:type') && _.addExtension(context, SCHEMAS.product) && DONE;
+    _.rename(obj, 's5p:shape', 'proj:shape') && _.addExtension(context, SCHEMAS.projection) && DONE;
+
+    _.upgradeExtension(context, SCHEMAS['sentinel-5p']);
+  },
+
   sci(obj, context) {
     // Nothing to do
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@radiantearth/stac-migrate",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "A library to update STAC files to the latest version.",
   "main": "migrate.js",
   "bin": {