@radiantearth/stac-migrate 1.1.0 → 1.3.0

package/README.md

@@ -2,10 +2,12 @@
 
 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.1.0**
+Version of this library: **1.3.0**
 
 ## Usage
 
+### JavaScript / Node
+
 Add to your project with `npm install @radiantearth/stac-migrate --save`
 
 Import the library: `const Migrate = require('@radiantearth/stac-migrate');`
@@ -19,25 +21,38 @@ Import the library: `const Migrate = require('@radiantearth/stac-migrate');`
 
 **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>`
+
 ##  Supported Extensions
 
-* Checksum (use `Migrate.enableMultihash(require('multihashes'))` to enable conversion from pre-0.9 checksums - disabled by default to keep the bundle size low)
-* Collection Assets 1.0.0
-* Commons
-* Data Cube 1.0.0
-* Datetime Range
+* 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.0
+* Label 1.0.1
 * Point Cloud 1.0.0
-* Procesing 1.0.0
+* Procesing 1.1.0
 * Projection 1.0.0
-* Raster 1.0.0
+* Raster 1.1.0
 * SAR 1.0.0
 * Satellite 1.0.0
-* Scientific 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

package/bin/cli.js

@@ -0,0 +1,70 @@
+#!/usr/bin/env node
+const fs = require('fs');
+const yargs = require('yargs/yargs')
+const { hideBin } = require('yargs/helpers')
+const Migrate = require('../migrate');
+const package = require("../package.json");
+
+const args = yargs(hideBin(process.argv))
+  .option('_', {
+    type: 'string',
+    describe: 'File to load the STAC data from'
+  })
+  .option('dest', {
+    type: 'string',
+    description: 'File to save the result to',
+    alias: 'd'
+  })
+  .option('collection', {
+    type: 'boolean',
+    description: 'Enforce the collection migration',
+    conflicts: ['catalog', 'item'],
+
+  })
+  .option('catalog', {
+    type: 'boolean',
+    description: 'Enforce the catalog migration',
+    conflicts: ['collection', 'item',]
+  })
+  .option('item', {
+    type: 'boolean',
+    description: 'Enforce the item migration',
+    conflicts: ['catalog', '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']
+  })
+  .option('indent', {
+    type: 'number',
+    description: 'Number of spaces to use for JSON indentation',
+    default: 2
+  })
+  .help()
+  .parse()
+
+run(args);
+
+function run(args) {
+  console.log("STAC Migrate v" + package.version);
+  let fn = ['collection', 'catalog', 'item'].find(type => Boolean(args[type])) || 'stac';
+  if (args._.length !== 1) {
+    throw new Error("Please provide exatctly one source file.");
+  }
+  let src = args._[0];
+  let dest = args.dest || src;
+
+  let dataStr = fs.readFileSync(src);
+  let dataObj = JSON.parse(dataStr);
+  let options = [dataObj];
+  if (fn === 'item') {
+    let collestionStr = fs.readFileSync(args.collection_path);
+    let collestionObj = JSON.parse(collestionStr);
+    options.push(collestionObj);
+  }
+  Migrate[fn](...options)
+  dataStr = JSON.stringify(dataObj, null, args.indent);
+  fs.writeFileSync(dest, dataStr);
+  console.log("Migrated successfully: " + dest);
+}