@radiantearth/stac-migrate 1.4.0 → 1.6.0

package/README.md

@@ -1,64 +1,66 @@
-# stac-migrate
-
-A library to update STAC files to the latest version (**1.0.0** at the moment of writing). Supports updating **STAC versions 0.6.0 and later**.
-
-Version of this library: **1.4.0**
-
-## Usage
-
-### JavaScript / Node
-
-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, 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, 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));`.
-
-### CLI
-
-You can also use the CLI to migrate a single file.
-The commands follow the different methods above and has the same "restrictions" as above.
-
-* Migrate (auto-detection, override): `npx stac-migrate <source_path>`
-* Migrate (auto-detection, save to a different file with 4 spaces indentation): `npx stac-migrate <source_path> --dest <dest_path> --indent 4`
-* 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
-
-* Checksum (legacy, use `Migrate.enableMultihash(require('multihashes'))` to enable conversion from pre-0.9 checksums - disabled by default to keep the bundle size low)
-* Classification 1.1.0
-* Collection Assets (legacy)
-* Commons (legacy)
-* Data Cube 2.1.0
-* Datetime Range (legacy)
-* Electro-Optical 1.0.0
-* File 1.0.0
-* (Item) Asset Definition 1.0.0
-* Label 1.0.1
-* Point Cloud 1.0.0
-* Procesing 1.1.0
-* Projection 1.0.0
-* Raster 1.1.0
-* SAR 1.0.0
-* Satellite 1.0.0
-* Scientific Citation 1.0.0
-* Single Item
-* Table 1.2.0
-* Timestamps 1.0.0
-* Versioning Indicators 1.0.0
-* View Geometry 1.0.0
-
-## Development
-
-Run the tests: `npm test`
+# stac-migrate
+
+A library to update STAC files to the latest version (**1.0.0** at the moment of writing). Supports updating **STAC versions 0.6.0 and later**.
+
+Version of this library: **1.6.0**
+
+## Usage
+
+### JavaScript / Node
+
+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, 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, 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 CollectionCollection: `Migrate.collectionCollection(apiCollections: object, updateVersionNumber: boolean = true) => object`
+* Migrate a STAC ItemCollection: `Migrate.itemCollection(apiItems: 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));`.
+
+### CLI
+
+You can also use the CLI to migrate a single file.
+The commands follow the different methods above and has the same "restrictions" as above.
+
+* Migrate (auto-detection, override): `npx stac-migrate <source_path>`
+* Migrate (auto-detection, save to a different file with 4 spaces indentation): `npx stac-migrate <source_path> --dest <dest_path> --indent 4`
+* 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`
+* Migrate a STAC Collection Collection: `npx stac-migrate <source_path> <dest_path> --collecions`
+
+##  Supported Extensions
+
+* Checksum (legacy, use `Migrate.enableMultihash(require('multihashes'))` to enable conversion from pre-0.9 checksums - disabled by default to keep the bundle size low)
+* Classification 1.1.0
+* Collection Assets (legacy)
+* Commons (legacy)
+* Data Cube 2.1.0
+* Datetime Range (legacy)
+* Electro-Optical 1.0.0
+* File 1.0.0
+* (Item) Asset Definition 1.0.0
+* Label 1.0.1
+* Point Cloud 1.0.0
+* Procesing 1.1.0
+* Projection 1.0.0
+* Raster 1.1.0
+* SAR 1.0.0
+* Satellite 1.0.0
+* Scientific Citation 1.0.0
+* Single Item
+* Table 1.2.0
+* Timestamps 1.0.0
+* Versioning Indicators 1.0.0
+* View Geometry 1.0.0
+
+## Development
+
+Run the tests: `npm test`

package/bin/cli.js

@@ -18,28 +18,33 @@ const args = yargs(hideBin(process.argv))
   .option('collection', {
     type: 'boolean',
     description: 'Enforce the collection migration',
-    conflicts: ['catalog', 'item', 'item_collection'],
+    conflicts: ['catalog', 'collections', 'item', 'item_collection'],
 
   })
   .option('catalog', {
     type: 'boolean',
     description: 'Enforce the catalog migration',
-    conflicts: ['collection', 'item', 'item_collection']
+    conflicts: ['collection', 'collections', 'item', 'item_collection']
   })
   .option('item', {
     type: 'boolean',
     description: 'Enforce the item migration',
-    conflicts: ['catalog', 'collection', 'item_collection']
+    conflicts: ['catalog', 'collection', 'collections', 'item_collection']
   })
   .option('item_collection', {
     type: 'boolean',
     description: 'Enforce the item collection migration',
-    conflicts: ['catalog', 'collection', 'item']
+    conflicts: ['catalog', 'collection', 'collections', 'item']
+  })
+  .option('collections', {
+    type: 'boolean',
+    description: 'Enforce the collection collection migration',
+    conflicts: ['catalog', 'collection', 'item', 'item_collection']
   })
   .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', 'item_collection']
+    conflicts: ['catalog', 'collection', 'collections', 'item_collection']
   })
   .option('indent', {
     type: 'number',
@@ -53,9 +58,13 @@ run(args);
 
 function run(args) {
   console.log("STAC Migrate v" + package.version);
-  let fn = ['collection', 'catalog', 'item', 'item_collection'].find(type => Boolean(args[type])) || 'stac';
-  if (fn === 'item_collection') {
-    fn = 'itemCollection';
+  let fn = ['collection', 'collections', 'catalog', 'item', 'item_collection'].find(type => Boolean(args[type])) || 'stac';
+  let fns = {
+    item_collection: 'itemCollection',
+    collections: 'collectionCollection'
+  };
+  if (fns[fn]) {
+    fn = fns[fn];
   }
   if (args._.length !== 1) {
     throw new Error("Please provide exactly one source file.");

package/migrate.js

@@ -406,14 +406,6 @@ var Catalog = {
 		return catalog;
 	},
 
-	openeo(obj) {
-		_.rename(obj, 'api_version', 'openeo:api_version') && DONE;
-		_.rename(obj, 'backend_version', 'openeo:backend_version') && DONE;
-		_.rename(obj, 'production', 'openeo:production') && DONE;
-		_.rename(obj, 'endpoints', 'openeo:endpoints') && DONE;
-		_.rename(obj, 'billing', 'openeo:billing') && DONE;
-	},
-
 };
 
 var Collection = {
@@ -556,7 +548,7 @@ var Collection = {
 		_.ensure(collection, 'summaries', {});
 
 		// other_properties: An early version of the Collection summaries with a similar structure
-		// Was mostly used in standalone collctions from openEO and GEE. Move other_properties to summaries.
+		// Was mostly used in standalone collections from openEO and GEE. Move other_properties to summaries.
 		if (V.before('0.8.0') && _.isObject(collection.other_properties)) {
 			for(let key in collection.other_properties) {
 				let prop = collection.other_properties[key];
@@ -662,6 +654,21 @@ var Item = {
 
 };
 
+var CollectionCollection = {
+
+	migrate(object, updateVersionNumber = true) {
+		_.ensure(object, 'collections', []) && DONE;
+		_.ensure(object, 'links', []) && DONE;
+
+		_.runAll(CollectionCollection, object, object);
+
+		object.collections = object.collections.map(collection => Collection.migrate(collection, updateVersionNumber));
+
+		return object;
+	},
+
+};
+
 var ItemCollection = {
 
 	migrate(itemCollection, updateVersionNumber = true) {
@@ -930,6 +937,10 @@ var Migrate = {
 		return Collection.migrate(collection, updateVersionNumber);
 	},
 
+	collectionCollection(collections, updateVersionNumber = true) {
+		return CollectionCollection.migrate(collections, updateVersionNumber);
+	},
+
 	itemCollection(itemCollection, updateVersionNumber = true) {
 		return ItemCollection.migrate(itemCollection, updateVersionNumber);
 	},
@@ -941,9 +952,12 @@ var Migrate = {
 		else if (object.type === 'FeatureCollection') {
 			return Migrate.itemCollection(object, updateVersionNumber);
 		}
-		else if (object.type === 'Collection' || _.isDefined(object.extent) || _.isDefined(object.license)) {
+		else if (object.type === 'Collection' || (!object.type && _.isDefined(object.extent) && _.isDefined(object.license))) {
 			return Migrate.collection(object, updateVersionNumber);
 		}
+		else if (!object.type && Array.isArray(object.collections)) {
+			return Migrate.collectionCollection(object, updateVersionNumber);
+		}
 		else {
 			return Migrate.catalog(object, updateVersionNumber);
 		}
@@ -955,4 +969,4 @@ var Migrate = {
 
 };
 
-module.exports = Migrate;
+module.exports = Migrate;

package/package.json

@@ -1,39 +1,39 @@
-{
-	"name": "@radiantearth/stac-migrate",
-	"version": "1.4.0",
-	"description": "A library to update STAC files to the latest version.",
-	"main": "migrate.js",
-	"bin": {
-		"stac-migrate": "./bin/cli.js"
-	},
-	"bugs": {
-		"url": "https://github.com/stac-utils/stac-migrate/issues"
-	},
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/stac-utils/stac-migrate.git"
-	},
-	"author": "Radiant Earth Foundation <hello@radiant.earth>",
-	"contributors": [
-		{
-			"name": "Matthias Mohr"
-		}
-	],
-	"license": "Apache-2.0",
-	"dependencies": {
-		"compare-versions": "^3.6.0",
-		"multihashes": "^3.1.2",
-		"yargs": "^17.6.2"
-	},
-	"devDependencies": {
-		"jest": "^29.0.0",
-		"jest-html-reporter": "^3.3.0"
-	},
-	"files": [
-		"bin/cli.js",
-		"migrate.js"
-	],
-	"scripts": {
-		"test": " jest"
-	}
-}
+{
+	"name": "@radiantearth/stac-migrate",
+	"version": "1.6.0",
+	"description": "A library to update STAC files to the latest version.",
+	"main": "migrate.js",
+	"bin": {
+		"stac-migrate": "./bin/cli.js"
+	},
+	"bugs": {
+		"url": "https://github.com/stac-utils/stac-migrate/issues"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/stac-utils/stac-migrate.git"
+	},
+	"author": "Radiant Earth Foundation <hello@radiant.earth>",
+	"contributors": [
+		{
+			"name": "Matthias Mohr"
+		}
+	],
+	"license": "Apache-2.0",
+	"dependencies": {
+		"compare-versions": "^3.6.0",
+		"multihashes": "^3.1.2",
+		"yargs": "^17.6.2"
+	},
+	"devDependencies": {
+		"jest": "^29.0.0",
+		"jest-html-reporter": "^3.3.0"
+	},
+	"files": [
+		"bin/cli.js",
+		"migrate.js"
+	],
+	"scripts": {
+		"test": " jest"
+	}
+}