Add support for Item Collections

Author: m-mohr

README.md

@@ -12,12 +12,13 @@ Add to your project with `npm install @radiantearth/stac-migrate --save`
 
 Import the library: `const Migrate = require('@radiantearth/stac-migrate');`
 
-* Migrate (auto-detection): `Migrate.stac(stac: object) => object`<br />
+* Migrate (auto-detection): `Migrate.stac(stac: object, updateVersionNumber: boolean = true) => object`<br />
   *This method does not migrate the Commons extension - use `Migrate.item` if you have used the Commons extension.*
-* Migrate a STAC Collection: `Migrate.collection(collection: object) => object`
-* Migrate a STAC Catalog: `Migrate.catalog(catalog: object) => object`
-* Migrate a STAC Item: `Migrate.item(item: object, collection: object = null) => object`<br />
+* Migrate a STAC Collection: `Migrate.collection(collection: object, updateVersionNumber: boolean = true) => object`
+* Migrate a STAC Catalog: `Migrate.catalog(catalog: object, updateVersionNumber: boolean = true) => object`
+* Migrate a STAC Item: `Migrate.item(item: object, collection: object = null, updateVersionNumber: boolean = true) => object`<br />
   *The `collection` parameter is only required to migrate the Commons extension. Otherwise, you don't need to pass this paramater.*
+* Migrate a STAC ItemCollection: `Migrate.itemCollection(catalog: object, updateVersionNumber: boolean = true) => object`
 
 **Note:** All changes will be applied in-place! If you don't want the input object to change, make a deep clone before. If you don't have a library which supports this (e.g. [lodash](https://lodash.com/docs/4.17.15#cloneDeep)) you can simply use `var clone = JSON.parse(JSON.stringify(object));`.
 
@@ -31,6 +32,7 @@ The commands follow the different methods above and has the same "restrictions"
 * Migrate a STAC Collection: `npx stac-migrate <source_path> <dest_path> --collection`
 * Migrate a STAC Catalog: `npx stac-migrate <source_path> <dest_path> --catalog`
 * Migrate a STAC Item: `npx stac-migrate <source_path> <dest_path> --item --collection_path <collection_path>`
+* Migrate a STAC Item Collection: `npx stac-migrate <source_path> <dest_path> --item_collection`
 
 ##  Supported Extensions
 

bin/cli.js

@@ -18,23 +18,28 @@ const args = yargs(hideBin(process.argv))
   .option('collection', {
     type: 'boolean',
     description: 'Enforce the collection migration',
-    conflicts: ['catalog', 'item'],
+    conflicts: ['catalog', 'item', 'item_collection'],
 
   })
   .option('catalog', {
     type: 'boolean',
     description: 'Enforce the catalog migration',
-    conflicts: ['collection', 'item',]
+    conflicts: ['collection', 'item', 'item_collection']
   })
   .option('item', {
     type: 'boolean',
     description: 'Enforce the item migration',
-    conflicts: ['catalog', 'collection']
+    conflicts: ['catalog', 'collection', 'item_collection']
+  })
+  .option('item_collection', {
+    type: 'boolean',
+    description: 'Enforce the item collection migration',
+    conflicts: ['catalog', 'collection', 'item']
   })
   .option('collection_path', {
     type: 'string',
     description: 'Pass the path to a collection to the item, only possible if --item has been specified.',
-    conflicts: ['catalog', 'collection']
+    conflicts: ['catalog', 'collection', 'item_collection']
   })
   .option('indent', {
     type: 'number',
@@ -48,9 +53,12 @@ run(args);
 
 function run(args) {
   console.log("STAC Migrate v" + package.version);
-  let fn = ['collection', 'catalog', 'item'].find(type => Boolean(args[type])) || 'stac';
+  let fn = ['collection', 'catalog', 'item', 'item_collection'].find(type => Boolean(args[type])) || 'stac';
+  if (fn === 'item_collection') {
+    fn = 'itemCollection';
+  }
   if (args._.length !== 1) {
-    throw new Error("Please provide exatctly one source file.");
+    throw new Error("Please provide exactly one source file.");
   }
   let src = args._[0];
   let dest = args.dest || src;

migrate.js

@@ -402,6 +402,8 @@ var Catalog = {
 		_.runAll(Catalog, catalog, catalog);
 
 		V.before('0.8.0') && _.populateExtensions(catalog, 'catalog') && DONE;
+
+		return catalog;
 	},
 
 	openeo(obj) {
@@ -442,6 +444,8 @@ var Collection = {
 
 		V.before('0.8.0') && _.populateExtensions(collection, 'collection') && DONE;
 		V.before('1.0.0-beta.1') && _.mapValues(collection, 'stac_extensions', ['assets'], ['item-assets']) && DONE;
+
+		return collection;
 	},
 
 	extent(collection) {
@@ -652,10 +656,28 @@ var Item = {
 
 		// Also populate extensions if commons has been implemented
 		(V.before('0.8.0') || commons) && _.populateExtensions(item, 'item') && DONE;
+
+		return item;
 	}
 
 };
 
+var ItemCollection = {
+
+	migrate(itemCollection, updateVersionNumber = true) {
+		_.ensure(itemCollection, 'type', 'FeatureCollection') && DONE;
+		_.ensure(itemCollection, 'features', []) && DONE;
+		_.ensure(itemCollection, 'links', []) && DONE;
+
+		_.runAll(ItemCollection, itemCollection, itemCollection);
+
+		itemCollection.features = itemCollection.features.map(feature => Item.migrate(feature, null, updateVersionNumber));
+
+		return itemCollection;
+	},
+
+};
+
 var Asset = {
 
 	migrateAll(context, field = 'assets') {
@@ -666,7 +688,10 @@ var Asset = {
 
 	migrate(asset, context) {
 		_.runAll(Asset, asset, context);
+
 		Fields.migrate(asset, context);
+
+		return asset;
 	},
 
 	mediaTypes(asset) {
@@ -699,6 +724,8 @@ var Fields = {
 
 	migrate(obj, context, summaries = false) {
 		_.runAll(Fields, obj, context, summaries);
+
+		return obj;
 	},
 
 	_commonMetadata(obj) {
@@ -892,24 +919,28 @@ var Fields = {
 var Migrate = {
 
 	item(item, collection = null, updateVersionNumber = true) {
-		Item.migrate(item, collection, updateVersionNumber);
-		return item;
+		return Item.migrate(item, collection, updateVersionNumber);
 	},
 
 	catalog(catalog, updateVersionNumber = true) {
-		Catalog.migrate(catalog, updateVersionNumber);
-		return catalog;
+		return Catalog.migrate(catalog, updateVersionNumber);
 	},
 
 	collection(collection, updateVersionNumber = true) {
-		Collection.migrate(collection, updateVersionNumber);
-		return collection;
+		return Collection.migrate(collection, updateVersionNumber);
+	},
+
+	itemCollection(itemCollection, updateVersionNumber = true) {
+		return ItemCollection.migrate(itemCollection, updateVersionNumber);
 	},
 
 	stac(object, updateVersionNumber = true) {
 		if (object.type === 'Feature') {
 			return Migrate.item(object, null, updateVersionNumber);
 		}
+		else if (object.type === 'FeatureCollection') {
+			return Migrate.itemCollection(object, updateVersionNumber);
+		}
 		else if (object.type === 'Collection' || _.isDefined(object.extent) || _.isDefined(object.license)) {
 			return Migrate.collection(object, updateVersionNumber);
 		}

tests/migrate.test.js

@@ -33,4 +33,16 @@ describe('STAC Migrations', () => {
         const legacyCollection09 = loadJson('legacy/collection-sar-0.9.json');
         expect(Migrate.item(legacyItem, legacyCollection09)).toEqual(latestItem);
     });
+
+    test('ItemCollection', () => {
+        const legacy1 = loadJson('legacy/item-minimal.json');
+        const latest1 = loadJson('latest/item-minimal.json');
+        const legacy2 = loadJson('legacy/item-sample.json');
+        const latest2 = loadJson('latest/item-sample.json');
+        const legacy = {type: "FeatureCollection", features: [legacy1, legacy2]};
+        const latest = {type: "FeatureCollection", features: [latest1, latest2], links: []};
+
+        expect(Migrate.itemCollection(legacy)).toEqual(latest);
+        expect(Migrate.stac(legacy)).toEqual(latest);
+    });
 });