para-cli 1.16.0 → 1.18.0

package/LICENSE

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2021 Erudika LTD, https://erudika.com
+   Copyright 2022 Erudika LTD, https://erudika.com
    
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/README.md

@@ -19,6 +19,7 @@ This is the command-line tool for interacting with a Para server.
 ```sh
 $ npm install -g para-cli
 $ para-cli setup
+$ para-cli ping
 ```
 
 ## Usage
@@ -38,6 +39,8 @@ $ para-cli setup
 
 	Commands:
 	  setup                                  Initial setup, prompts you to enter your Para API keys and endpoint
+	  apps                                   Returns a list of all Para apps
+	  select <appid>                         Selects a Para app as a target for all subsequent read/write requests.
 	  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)

package/index.js

@@ -1,5 +1,5 @@
 /*
- * Copyright 2013-2021 Erudika. https://erudika.com
+ * Copyright 2013-2022 Erudika. https://erudika.com
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,7 +25,6 @@
 /* eslint indent: ["error", "tab"] */
 /* eslint object-curly-spacing: ["error", "always"] */
 
-'use strict';
 import { statSync, readFileSync, writeFileSync } from 'fs';
 import { relative, basename, resolve } from 'path';
 import { TextEncoder } from 'util';
@@ -35,7 +34,7 @@ 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';
@@ -57,12 +56,28 @@ export function setup(config) {
 	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');
+				var access = (accessKey || config.get('accessKey')).trim();
+				var secret = (secretKey || config.get('secretKey')).trim();
+				var endpoint = (endpoint || config.get('endpoint')).trim();
 				newJWT(access, secret, endpoint, config);
 				var pc = new ParaClient(access, secret, { endpoint: endpoint || defaultConfig.endpoint });
 				ping(pc, config);
-				rl.close();
+				if (access === 'app:para') {
+					listApps(pc, function () {
+						// if none, ask to create one
+						rl.question(cyan.bold('Would you like to create a new Para app? [Y/n] '), function (Yn) {
+							Yn = Yn.trim();
+							if ('' === Yn || 'y' === Yn || 'Y' === Yn) {
+								rl.question(cyan.bold('App name: '), function (appname) {
+									newApp(pc, ['', appname], {});
+									rl.close();
+								});
+							} else {
+								rl.close();
+							}
+						});
+					});
+				}
 			});
 		});
 	});
@@ -74,7 +89,7 @@ export function createAll(pc, input, flags) {
 		return;
 	}
 
-	var files = sync(input[1], { realpath: true });
+	var files = globbySync(input[1], { realpath: true });
 	var totalSize = 0;
 	var totalObjects = 0;
 	var batches = [[]];
@@ -185,7 +200,7 @@ export function updateAll(pc, input, flags) {
 		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++) {
@@ -219,7 +234,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)];
 		}
@@ -295,9 +310,11 @@ export function ping(pc, config) {
 				cyan(mee.type + ' ' + mee.name + ' (' + mee.id + ')'));
 		}).catch(function () {
 			fail('Connection failed. Run "para-cli setup" or check the configuration file', yellow(config.path));
+			process.exit(1);
 		});
 	}).catch(function () {
 		fail('Connection failed. Run "para-cli setup" or check the configuration file', yellow(config.path));
+		process.exit(1);
 	});
 }
 
@@ -354,7 +371,9 @@ function promiseWhile(results, fn) {
 		function loop() {
 			return Promise.resolve(fn()).then(function (result) {
 				if (result && result.length > 0) {
-					results = results.concat(result);
+					result.forEach(function (res) {
+						results.push(res);
+					});
 					return loop();
 				}
 				resolve();
@@ -407,6 +426,67 @@ export function rebuildIndex(pc, config, flags) {
 	});
 }
 
+export function listApps(config, flags, parentAccessKey, failureCallback) {
+	var accessKey = flags.accessKey || process.env.PARA_ACCESS_KEY || config.get('accessKey');
+	var secretKey = flags.secretKey || process.env.PARA_SECRET_KEY || config.get('secretKey');
+	var endpoint = flags.endpoint || process.env.PARA_ENDPOINT || config.get('endpoint');
+	var pc = new ParaClient(accessKey, secretKey, {endpoint: endpoint});
+	var p = new Pager();
+	var results = [];
+	p.sortby = '_docid';
+	p.page = 1;
+	promiseWhile(results, function () {
+		return pc.findQuery('app', '*', p);
+	}).then(function () {
+		var apps = results.map(function (app) {return app.appIdentifier.trim();});
+		if (apps.length) {
+			console.log('Found', p.count, 'apps:', yellow('[') + green(apps.join(yellow('] ['))) + yellow(']'));
+			console.log('Typing', cyan('para-cli select'), green(apps[0]), 'will switch to that app. Current app:',
+				green(parentAccessKey));
+			process.exit(0);
+		} else {
+			failureCallback();
+		}
+	}).catch(function (err) {
+		failureCallback();
+	});
+}
+
+export function selectApp(pc, input, config, flags) {
+	var accessKey = flags.accessKey || process.env.PARA_ACCESS_KEY || config.get('accessKey');
+	var secretKey = flags.secretKey || process.env.PARA_SECRET_KEY || config.get('secretKey');
+	if (accessKey === 'app:para' && secretKey) {
+		var selectedApp = 'app:' + (input[1] || 'para').trim();
+		if (selectedApp === 'app:para') {
+			config.delete('selectedApp');
+			console.log(green('✔'), 'Selected', green(selectedApp), 'as the current app.');
+			return;
+		}
+		var now = Math.round(new Date().getTime() / 1000);
+		var jwt = sign(JSON.stringify({
+			iat: now,
+			exp: now + 60,
+			appid: accessKey,
+			getCredentials: selectedApp
+		}), secretKey, { algorithm: 'HS256' });
+		pc.setAccessToken(jwt);
+		pc.me(jwt).then(function (data) {
+			if (data && data.credentials) {
+				config.set('selectedApp', data.credentials);
+				console.log(green('✔'), 'Selected', green(selectedApp), 'as the current app.');
+			} else {
+				fail('That did not work -' + red(input[1]) + ' try updating Para to the latest version.');
+			}
+			pc.clearAccessToken();
+		}).catch(function (err) {
+			fail('App ' + red(input[1]) + ' not found!');
+			pc.clearAccessToken();
+		});
+	} else {
+		fail('This command only works when Para CLI is configured to use the keys for the root app.');
+	}
+}
+
 function sendFileChunk(chunkId, textEncoded, json, id, flags, start, end, pc, decoder) {
 	if (start > 0 && textEncoded[start] !== 32) {
 		for (var i = 0; i < 100 && start - i >= 0; i++) {

package/package.json

@@ -1,9 +1,11 @@
 {
   "name": "para-cli",
-  "version": "1.16.0",
+  "version": "1.18.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,47 +24,23 @@
     "api"
   ],
   "devDependencies": {
-    "eslint": "^7.28.0",
-    "eslint-config-xo-space": "^0.28.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.8.0"
   },
   "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.4",
-    "htmlparser2": "^6.1.0",
+    "globby": "^13.1.1",
+    "htmlparser2": "^7.2.0",
     "jsonwebtoken": "^8.5.1",
     "meow": "^10.0.1",
     "mime-types": "^2.1.31",
-    "para-client-js": "^1.37.6",
-    "resolve": "^1.20.0",
+    "para-client-js": "^1.37.9",
+    "resolve": "^1.22.0",
     "striptags": "^3.1.1",
     "update-notifier": "^5.1.0",
     "yargs-parser": ">=20.2.7"

package/para-cli.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 /*
- * Copyright 2013-2021 Erudika. https://erudika.com
+ * Copyright 2013-2022 Erudika. https://erudika.com
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,17 +21,15 @@
 /* eslint indent: ["error", "tab"] */
 /* eslint object-curly-spacing: ["error", "always"] */
 
-'use strict';
-
 import updateNotifier from 'update-notifier';
 import ParaClient from 'para-client-js';
 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, exportData, importData } from './index.js';
+import { defaultConfig, setup, listApps, selectApp, createAll, readAll, updateAll, deleteAll, search, newKeys, newJWT, newApp, ping, me, appSettings, rebuildIndex, exportData, importData } from './index.js';
 
-const { blue } = chalk;
+const { red, green, blue } = chalk;
 const { textSync } = figlet;
 
 var cli = meow(`
@@ -40,6 +38,8 @@ var cli = meow(`
 
 	Commands:
 	  setup                                  Initial setup, prompts you to enter your Para API keys and endpoint
+	  apps                                   Returns a list of all Para apps
+	  select <appid>                         Selects a Para app as a target for all subsequent read/write requests.
 	  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)
@@ -106,68 +106,88 @@ var flags = cli.flags;
 var accessKey = flags.accessKey || process.env.PARA_ACCESS_KEY || config.get('accessKey');
 var secretKey = flags.secretKey || process.env.PARA_SECRET_KEY || config.get('secretKey');
 var endpoint = flags.endpoint || process.env.PARA_ENDPOINT || config.get('endpoint');
-var pc = new ParaClient(accessKey, secretKey, { endpoint: endpoint });
+var selectedApp = config.get('selectedApp');
 
-if (!input[0]) {
-	console.log(help);
+if (selectedApp && selectedApp.accessKey && selectedApp.accessKey.indexOf("app:") === 0) {
+	accessKey = selectedApp.accessKey;
+	secretKey = selectedApp.secretKey;
 }
 
-if (input[0] === 'setup') {
+if (!input[0]) {
+	console.log(help);
+} else if (!accessKey || !secretKey) {
+	console.error(red('Command ' + input[0] + ' failed! Blank credentials, running setup first...'));
+	process.exitCode = 1;
 	setup(config);
-}
+} else {
+	var pc = new ParaClient(accessKey, secretKey, { endpoint: endpoint });
 
-if (input[0] === 'create') {
-	createAll(pc, input, flags);
-}
+	if (input[0] === 'setup') {
+		setup(config);
+	}
 
-if (input[0] === 'read') {
-	readAll(pc, flags);
-}
+	if (input[0] === 'apps') {
+		listApps(config, flags, accessKey, function () {console.log('No apps found within', green(accessKey));});
+	}
 
-if (input[0] === 'update') {
-	updateAll(pc, input, flags);
-}
+	if (input[0] === 'select') {
+		selectApp(pc, input, config, flags);
+	}
 
-if (input[0] === 'delete') {
-	deleteAll(pc, input, flags);
-}
+	if (input[0] === 'create') {
+		createAll(pc, input, flags);
+	}
 
-if (input[0] === 'search') {
-	search(pc, input, flags);
-}
+	if (input[0] === 'read') {
+		readAll(pc, flags);
+	}
 
-if (input[0] === 'new-key') {
-	newKeys(pc, config);
-}
+	if (input[0] === 'update') {
+		updateAll(pc, input, flags);
+	}
 
-if (input[0] === 'new-jwt') {
-	newJWT(accessKey, secretKey, endpoint, config);
-}
+	if (input[0] === 'delete') {
+		deleteAll(pc, input, flags);
+	}
 
-if (input[0] === 'new-app') {
-	newApp(pc, input, flags);
-}
+	if (input[0] === 'search') {
+		search(pc, input, flags);
+	}
 
-if (input[0] === 'ping') {
-	ping(pc, config);
-}
+	if (input[0] === 'new-key') {
+		newKeys(pc, config);
+	}
 
-if (input[0] === 'me') {
-	me(pc, config);
-}
+	if (input[0] === 'new-jwt') {
+		newJWT(accessKey, secretKey, endpoint, config);
+	}
 
-if (input[0] === 'app-settings') {
-	appSettings(pc, config);
-}
+	if (input[0] === 'new-app') {
+		newApp(pc, input, flags);
+	}
 
-if (input[0] === 'rebuild-index') {
-	rebuildIndex(pc, config, flags);
-}
+	if (input[0] === 'ping') {
+		ping(pc, config);
+	}
 
-if (input[0] === 'export') {
-	exportData(pc, config, flags);
-}
+	if (input[0] === 'me') {
+		me(pc, config);
+	}
+
+	if (input[0] === 'app-settings') {
+		appSettings(pc, config);
+	}
+
+	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);
+	if (input[0] === 'import') {
+		importData(pc, input, config);
+	}
 }
+