para-cli 1.15.0 → 1.17.0

package/README.md

@@ -34,50 +34,52 @@ $ para-cli setup
   Command-line tool for Para backend servers
 
   Usage:
-    $ para-cli [command] [file]
-
-  Commands:
-    setup                                  Initial setup, prompts you to enter your Para API keys and endpoint
-    create <file|glob> [--id] [--type]     Persists files as Para objects and makes them searchable
-    read --id 123 [--id 345 ...]           Fetches objects with the given ids
-    update <file.json|glob> ...            Updates Para objects with the data from a JSON file (must contain id field)
-    delete [glob] --id 123 ...             Deletes one or more objects from Para
-    search "query" [--limit --page --sort] Searches the Para index for objects given a query string
-    rebuild-index                          Rebuilds the entire search index
-    app-settings                           Returns all settings for the authenticated app
-    new-key                                Generates a new secret key and saves it to config.json
-    new-jwt                                Generates a new JWT super token to be used for app authentication
-    new-app <name> --name --shared         Creates a new Para app. Only works if you have the keys for the "root" app
-    ping                                   Tests the connection to the Para server
-    me                                     Returns the JSON for the currently authenticated user or app
-
-  Options:
-    --type          Sets the "type" field of an object
-    --id            Sets the "id" field of an object
-    --sanitize      Strips all symbols from input files
-    --accessKey     Sets the Para access key
-    --secretKey     Sets the Para secret key
-    --endpoint      Sets the URL of the Para server
-    --sort          Sets the field on which to sort search results
-    --desc          Descending sort for search results (default: true)
-    --page          Page number for search results, "all" will auto-paginate through all results
-    --limit         Limits the number of search results
-    --lastKey       Sets the last id for search-after pagination
-    --cwd           Sets the current directory - used for resolving file paths
-    --encodeId      By default all ids are Base64 encoded, unless this is 'false'
-    --help          Prints the list of commands
-    --version       Prints the version of the program
-
-  Examples:
-    $ para-cli setup
-    $ para-cli create my-blog-post.md
-    $ para-cli read --id my-blog-post.md
-    $ para-cli create index.html --type webpage --id "My new article" --sanitize
-    $ para-cli delete --id 123 --id "my-blog-post.md"
-    $ para-cli search "type:article AND title:*" --sort timestamp --desc false --limit 10
-    $ para-cli search "*" --type article --page all
-    $ para-cli new-key
-    $ para-cli new-app "mynewapp" --name "Full app name"
+	  $ para-cli [command] [file]
+
+	Commands:
+	  setup                                  Initial setup, prompts you to enter your Para API keys and endpoint
+	  create <file|glob> [--id] [--type]     Persists files as Para objects and makes them searchable
+	  read --id 123 [--id 345 ...]           Fetches objects with the given ids
+	  update <file.json|glob> ...            Updates Para objects with the data from a JSON file (must contain id field)
+	  delete [glob] --id 123 ...             Deletes one or more objects from Para
+	  search "query" [--limit --page --sort] Searches the Para index for objects given a query string
+	  rebuild-index                          Rebuilds the entire search index
+	  app-settings                           Returns all settings for the authenticated app
+	  new-key                                Generates a new secret key and saves it to config.json
+	  new-jwt                                Generates a new JWT super token to be used for app authentication
+	  new-app <name> --name --shared         Creates a new Para app. Only works if you have the keys for the "root" app
+	  export                                 Exports all data from the app's table
+	  import <file>                          Imports data from a previously exported ZIP archive
+	  ping                                   Tests the connection to the Para server
+	  me                                     Returns the JSON for the currently authenticated user or app
+
+	Options:
+	  --type          Sets the "type" field of an object
+	  --id            Sets the "id" field of an object
+	  --sanitize      Strips all symbols from input files
+	  --accessKey     Sets the Para access key
+	  --secretKey     Sets the Para secret key
+	  --endpoint      Sets the URL of the Para server
+	  --sort          Sets the field on which to sort search results
+	  --desc          Descending sort for search results (default: true)
+	  --page          Page number for search results, "all" will auto-paginate through all results
+	  --limit         Limits the number of search results
+	  --lastKey       Sets the last id for search-after pagination
+	  --cwd           Sets the current directory - used for resolving file paths
+	  --encodeId      By default all ids are Base64 encoded, unless this is 'false'
+	  --help          Prints the list of commands
+	  --version       Prints the version of the program
+
+	Examples:
+	  $ para-cli setup
+	  $ para-cli create my-blog-post.md
+	  $ para-cli read --id my-blog-post.md
+	  $ para-cli create index.html --type webpage --id "My new article" --sanitize
+	  $ para-cli delete --id 123 --id "my-blog-post.md"
+	  $ para-cli search "type:article AND title:*" --sort timestamp --desc false --limit 10
+	  $ para-cli search "*" --type article --page all
+	  $ para-cli new-key
+	  $ para-cli new-app "mynewapp" --name "Full app name"
 
 ```
 

package/index.js

@@ -26,8 +26,8 @@
 /* eslint object-curly-spacing: ["error", "always"] */
 
 'use strict';
-import { statSync, readFileSync } from 'fs';
-import { relative, basename } from 'path';
+import { statSync, readFileSync, writeFileSync } from 'fs';
+import { relative, basename, resolve } from 'path';
 import { TextEncoder } from 'util';
 var encoder = new TextEncoder('utf-8');
 import striptags from 'striptags';
@@ -35,9 +35,10 @@ import { Parser } from 'htmlparser2';
 import { createInterface } from 'readline';
 import jsonwebtoken from 'jsonwebtoken';
 import { lookup } from 'mime-types';
-import { sync } from 'globby';
+import { globbySync } from 'globby';
 import chalk from 'chalk';
 import { Promise } from 'rsvp';
+import apiClient from 'superagent';
 import { ParaClient, ParaObject, Pager } from 'para-client-js';
 
 const { cyan, red, yellow, green } = chalk;
@@ -53,15 +54,14 @@ export function setup(config) {
 		input: process.stdin,
 		output: process.stdout
 	});
-	var that = this;
 	rl.question(cyan.bold('Para Access Key: '), function (accessKey) {
 		rl.question(cyan.bold('Para Secret Key: '), function (secretKey) {
 			rl.question(cyan.bold('Para Endpoint: '), function (endpoint) {
 				var access = accessKey || config.get('accessKey');
 				var secret = secretKey || config.get('secretKey');
-				that.newJWT(access, secret, endpoint, config);
+				newJWT(access, secret, endpoint, config);
 				var pc = new ParaClient(access, secret, { endpoint: endpoint || defaultConfig.endpoint });
-				that.ping(pc, config);
+				ping(pc, config);
 				rl.close();
 			});
 		});
@@ -71,9 +71,10 @@ export function setup(config) {
 export function createAll(pc, input, flags) {
 	if (!input[1]) {
 		fail('No files specified.');
+		return;
 	}
 
-	var files = sync(input[1], { realpath: true });
+	var files = globbySync(input[1], { realpath: true });
 	var totalSize = 0;
 	var totalObjects = 0;
 	var batches = [[]];
@@ -181,9 +182,10 @@ export function readAll(pc, flags) {
 export function updateAll(pc, input, flags) {
 	if (!input[1]) {
 		fail('No files specified.');
+		return;
 	}
 
-	var files = sync(input[1], { realpath: true });
+	var files = globbySync(input[1], { realpath: true });
 	var updateList = [];
 
 	for (var i = 0; i < files.length; i++) {
@@ -217,7 +219,7 @@ export function updateAll(pc, input, flags) {
 
 export function deleteAll(pc, input, flags) {
 	if (flags.id || input[1]) {
-		var deleteIds = sync(input[1] || ' ', { realpath: true });
+		var deleteIds = globbySync(input[1] || ' ', { realpath: true });
 		if (deleteIds.length === 0) {
 			deleteIds = flags.id instanceof Array ? flags.id : [String(flags.id)];
 		}
@@ -248,6 +250,7 @@ export function newKeys(pc, config) {
 export function newJWT(accessKey, secretKey, endpoint, config) {
 	if (!accessKey || accessKey.length < 3 || !secretKey || secretKey.length < 6) {
 		fail('Invalid credentials.');
+		return;
 	}
 
 	var now = Math.round(new Date().getTime() / 1000);
@@ -267,6 +270,7 @@ export function newJWT(accessKey, secretKey, endpoint, config) {
 export function newApp(pc, input, flags) {
 	if (!input[1]) {
 		fail('App name not specified.');
+		return;
 	}
 
 	var appid = input[1];
@@ -305,6 +309,46 @@ export function me(pc, config) {
 	});
 }
 
+export function exportData(pc, config) {
+	pc.invokeGet('/_export').then(function (data) {
+		try {
+			var filename = (data.headers['content-disposition'] || 'export.zip');
+			var filesize = Math.round(((data.headers['content-length'] || 0) / 1000000) * 100) / 100;
+			filename = filename.substring(filename.lastIndexOf('=') + 1);
+			writeFileSync(filename, data.body);
+			console.log(green('✔'), yellow('Exported ' + filesize + 'MB of data to file ' + filename));
+		} catch (e) {
+			console.error(e);
+		}
+	}).catch(function () {
+		fail('Connection failed. Server might be down. Check the configuration file', yellow(config.path));
+	});
+}
+
+export function importData(pc, input, config) {
+	if (!input[1]) {
+		fail('No file to import.');
+		return;
+	}
+	if (!config.get('jwt')) {
+		newJWT(config.get('accessKey'), config.get('secretKey'), config.get('endpoint'), config);
+	}
+	var headers = {
+		'User-Agent': 'Para CLI tool',
+		'Content-Type': 'application/zip',
+		'Authorization': 'Bearer ' + config.get('jwt')
+	};
+	try {
+		apiClient.put(pc.endpoint + '/v1/_import').set(headers).send(readFileSync(resolve(input[1]))).then(function(res) {
+			console.log(green('✔'), yellow('Imported ' + res.body.count + ' object into app "' + res.body.appid) + '"');
+		}).catch(function (e) {
+			fail('Import request failed. ' + e);
+		});
+	} catch (e) {
+		fail('Import request failed: ' + e);
+	}
+}
+
 function promiseWhile(results, fn) {
 	return new Promise(function (resolve, _reject) {
 		function loop() {

package/package.json

@@ -1,9 +1,11 @@
 {
   "name": "para-cli",
-  "version": "1.15.0",
+  "version": "1.17.0",
+  "license": "Apache-2.0",
   "description": "Command-line tool for Para backend servers",
   "homepage": "https://paraio.org",
   "type": "module",
+  "exports": "./index.js",
   "author": {
     "name": "Alex Bogdanovski",
     "email": "alex@erudika.com",
@@ -22,46 +24,22 @@
     "api"
   ],
   "devDependencies": {
-    "eslint": "^7.25.0",
-    "eslint-config-xo-space": "^0.27.0",
-    "gulp": "^4.0.2",
-    "gulp-eslint": "^6.0.0",
-    "gulp-exclude-gitignore": "^1.2.0",
-    "gulp-istanbul": "^1.1.3",
-    "gulp-line-ending-corrector": "^1.0.3",
-    "gulp-mocha": "^8.0.0",
-    "gulp-plumber": "^1.2.1",
-    "gulp-xo": "^0.25.0",
-    "handlebars": "^4.7.6",
-    "lodash": "^4.17.21",
-    "mem": "^8.1.1",
-    "minimist": ">=1.2.3",
-    "yargs-parser": ">=20.2.7"
-  },
-  "eslintConfig": {
-    "extends": "xo-space",
-    "env": {
-      "mocha": true
-    }
+    "eslint": "^8.4.1"
   },
   "repository": "Erudika/para-cli",
-  "scripts": {
-    "test": "gulp"
-  },
-  "license": "Apache-2.0",
   "dependencies": {
     "brace-expansion": "^2.0.1",
-    "chalk": "^4.1.1",
+    "chalk": "^5.0.0",
     "conf": "^10.0.1",
     "exit": "^0.1.2",
     "figlet": "^1.5.0",
     "get-stdin": "^9.0.0",
-    "globby": "^11.0.3",
-    "htmlparser2": "^6.1.0",
+    "globby": "^12.0.2",
+    "htmlparser2": "^7.2.0",
     "jsonwebtoken": "^8.5.1",
-    "meow": "^10.0.0",
-    "mime-types": "^2.1.30",
-    "para-client-js": "^1.37.0",
+    "meow": "^10.0.1",
+    "mime-types": "^2.1.31",
+    "para-client-js": "^1.37.6",
     "resolve": "^1.20.0",
     "striptags": "^3.1.1",
     "update-notifier": "^5.1.0",

package/para-cli.js

@@ -29,7 +29,7 @@ import Conf from 'conf';
 import figlet from 'figlet';
 import chalk from 'chalk';
 import meow from 'meow';
-import { defaultConfig, setup, createAll, readAll, updateAll, deleteAll, search, newKeys, newJWT, newApp, ping, me, appSettings, rebuildIndex } from './index.js';
+import { defaultConfig, setup, createAll, readAll, updateAll, deleteAll, search, newKeys, newJWT, newApp, ping, me, appSettings, rebuildIndex, exportData, importData } from './index.js';
 
 const { blue } = chalk;
 const { textSync } = figlet;
@@ -50,6 +50,8 @@ var cli = meow(`
 	  new-key                                Generates a new secret key and saves it to config.json
 	  new-jwt                                Generates a new JWT super token to be used for app authentication
 	  new-app <name> --name --shared         Creates a new Para app. Only works if you have the keys for the "root" app
+	  export                                 Exports all data from the app's table
+	  import <file>                          Imports data from a previously exported ZIP archive
 	  ping                                   Tests the connection to the Para server
 	  me                                     Returns the JSON for the currently authenticated user or app
 
@@ -161,3 +163,11 @@ if (input[0] === 'app-settings') {
 if (input[0] === 'rebuild-index') {
 	rebuildIndex(pc, config, flags);
 }
+
+if (input[0] === 'export') {
+	exportData(pc, config, flags);
+}
+
+if (input[0] === 'import') {
+	importData(pc, input, config);
+}