para-cli 1.18.7 → 1.19.1

package/README.md

@@ -17,9 +17,9 @@ This is the command-line tool for interacting with a Para server.
 ## Installation
 
 ```sh
-$ npm install -g para-cli
-$ para-cli setup
-$ para-cli ping
+npm install -g para-cli
+para-cli setup
+para-cli ping
 ```
 
 ## Usage
@@ -41,6 +41,7 @@ $ para-cli ping
 	  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.
+	  endpoints [add|remove]                 List and select Para server endpoints, add new or remove an exiting one.
 	  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)
@@ -83,6 +84,9 @@ $ para-cli ping
 	  $ para-cli search "*" --type article --page all
 	  $ para-cli new-key
 	  $ para-cli new-app "mynewapp" --name "Full app name"
+	  $ para-cli apps
+	  $ para-cli select scoold
+	  $ para-cli endpoints
 
 ```
 
@@ -95,7 +99,7 @@ The plan is to add more functionality in the near future.
 
 **Quick start:**
 ```
-$ para-cli setup
+para-cli setup
 ```
 
 The configuration file is located in `~/.config/para-cli-nodejs/config.json` and contains the keys used to authenticate
@@ -115,12 +119,32 @@ Here's an example `config.json` file:
 Once configured you can test your connection to the server:
 
 ```
-$ para-cli ping
+para-cli ping
 ```
 
 To get the currently authenticated app/user object run:
 ```
-$ para-cli me
+para-cli me
+```
+
+## Switching between apps and endpoints
+
+Para CLI can be configured to work with multiple Para servers and apps. Here's how to add additional Para server endpoints:
+```
+para-cli endpoints add
+```
+To select a specific endpoint run:
+```
+para-cli endpoints
+```
+
+After selecting the Para server you wish to connect to, you can list and select apps within it:
+```
+para-cli apps
+```
+Select the 'scoold' app, for example:
+```
+para-cli select scoold
 ```
 
 ## Para Docs

package/index.js

@@ -38,6 +38,7 @@ import { globbySync } from 'globby';
 import chalk from 'chalk';
 import { Promise } from 'rsvp';
 import apiClient from 'superagent';
+import { URL } from 'url';
 import { ParaClient, ParaObject, Pager } from 'para-client-js';
 
 const { cyan, red, yellow, green } = chalk;
@@ -56,7 +57,7 @@ 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')).trim();
+				var access = (accessKey || config.get('accessKey') || "app:para").trim();
 				var secret = (secretKey || config.get('secretKey')).trim();
 				var endpoint = (endpoint || config.get('endpoint')).trim();
 				newJWT(access, secret, endpoint, config);
@@ -427,9 +428,10 @@ 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 selectedEndpoint = getSelectedEndpoint(config, flags);
+	var accessKey = selectedEndpoint.accessKey;
+	var secretKey = selectedEndpoint.secretKey;
+	var endpoint = selectedEndpoint.endpoint;
 	var pc = new ParaClient(accessKey, secretKey, {endpoint: endpoint});
 	var p = new Pager();
 	var results = [];
@@ -440,7 +442,7 @@ export function listApps(config, flags, parentAccessKey, failureCallback) {
 	}).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('Found', p.count, 'apps on ' + cyan(endpoint) + ':', 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);
@@ -452,9 +454,11 @@ export function listApps(config, flags, parentAccessKey, 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');
+export function selectApp(input, config, flags) {
+	var selectedEndpoint = getSelectedEndpoint(config, flags);
+	var accessKey = selectedEndpoint.accessKey;
+	var secretKey = selectedEndpoint.secretKey;
+	var endpoint = selectedEndpoint.endpoint;
 	if (accessKey === 'app:para' && secretKey) {
 		var selectedApp = 'app:' + (input[1] || 'para').trim();
 		if (selectedApp === 'app:para') {
@@ -465,28 +469,142 @@ export function selectApp(pc, input, config, flags) {
 		var now = Math.round(new Date().getTime() / 1000);
 		var jwt = sign(JSON.stringify({
 			iat: now,
-			exp: now + 60,
+			exp: now + 10,
 			appid: accessKey,
 			getCredentials: selectedApp
 		}), secretKey, { algorithm: 'HS256' });
-		pc.setAccessToken(jwt);
-		pc.me(jwt).then(function (data) {
+		var paraClient = new ParaClient(accessKey, secretKey, { endpoint: endpoint });
+		paraClient.setAccessToken(jwt);
+		paraClient.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.');
 	}
 }
 
+export function listEndpoints(config, flags, 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 endpoints = config.get('endpoints') || [];
+	var list = [{endpoint: endpoint, accessKey: accessKey, secretKey: secretKey}].concat(endpoints);
+	if (list.length === 0) {
+		failureCallback();
+		return [];
+	}
+	for (var i = 0; i < list.length; i++) {
+		var ep = list[i];
+		var selected = (config.get('selectedEndpoint') || 0) === i;
+		var rootAppConfigured = ep.accessKey === 'app:para' && ep.secretKey.length > 10;
+		console.log(yellow((selected ? ' ➤' : '  '), (i + 1) + '. ') + cyan(ep.endpoint), rootAppConfigured ?
+			green('✔ root app configured') : red('root app not configured'));
+	}
+	return list;
+}
+
+export function addEndpoint(config) {
+	var endpoints = config.get('endpoints') || [];
+	var rl = createInterface({
+		input: process.stdin,
+		output: process.stdout
+	});
+	rl.question(cyan.bold('Para Endpoint: '), function (endpoint) {
+		if (!isValidUrl(endpoint)) {
+			fail('Endpoint must be a valid URL.');
+			rl.close();
+			return;
+		}
+		rl.question(cyan.bold('Para Secret Key (for root app app:para): '), function (secretKey) {
+			var pc = new ParaClient("app:para", secretKey, {endpoint: endpoint});
+			var endpoints = config.get('endpoints') || [];
+			var existing = false;
+			for (var i = 0; i < endpoints.length; i++) {
+				var ep = endpoints[i];
+				if (ep.endpoint === endpoint) {
+					ep.secretKey = secretKey;
+					existing = true;
+				}
+			}
+			if (!existing) {
+				endpoints.push({accessKey: 'app:para', secretKey: secretKey, endpoint: endpoint});
+			}
+			config.set('endpoints', endpoints);
+			ping(pc, config);
+			rl.close();
+		});
+	});
+}
+
+export function removeEndpoint(config, flags) {
+	var list = listEndpoints(config, flags, function () {console.log('No endpoints found.');});
+	var rl = createInterface({
+		input: process.stdin,
+		output: process.stdout
+	});
+
+	rl.question(yellow.bold('Type the number of the Para endpoint to remove: '), function (index) {
+		var selectedEndpoint = 0;
+		if (!isNaN(index) && index <= list.length && index >= 1) {
+			selectedEndpoint = index - 1;
+		}
+		var url = list[selectedEndpoint].endpoint;
+		if (selectedEndpoint === 0) {
+			config.set('accessKey', 'app:para');
+			config.set('secretKey', '');
+			config.set('endpoint', defaultConfig.endpoint);
+		} else {
+			if (selectedEndpoint === config.get('selectedEndpoint')) {
+				config.delete('selectedEndpoint');
+				config.delete('selectedApp');
+			}
+			list.splice(selectedEndpoint, 1);
+			list.shift();
+			config.set('endpoints', list);
+		}
+		console.log("Removed endpoint: " + cyan(url));
+		rl.close();
+	});
+}
+
+export function selectEndpoint(config, flags) {
+	var list = listEndpoints(config, flags, function () {console.log('No endpoints found.');});
+	var rl = createInterface({
+		input: process.stdin,
+		output: process.stdout
+	});
+	rl.question(yellow.bold('Type the number of the Para endpoint to select: '), function (index) {
+		var selectedEndpoint = 0;
+		if (!isNaN(index) && index <= list.length && index >= 1) {
+			selectedEndpoint = index - 1;
+		}
+		config.delete('selectedApp');
+		config.set('selectedEndpoint', selectedEndpoint);
+		console.log("Selected endpoint: " + cyan(list[selectedEndpoint].endpoint));
+		rl.close();
+	});
+}
+
+function getSelectedEndpoint(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');
+	var endpoint = flags.endpoint || process.env.PARA_ENDPOINT || config.get('endpoint');
+	var endpoints = [{endpoint: endpoint, accessKey: accessKey, secretKey: secretKey}].concat(config.get('endpoints') || []);
+	try {
+		return endpoints[config.get('selectedEndpoint') || 0];
+	} catch (e) {
+		config.delete('selectedEndpoint');
+		return endpoints[0];
+	}
+}
+
 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++) {
@@ -604,6 +722,15 @@ function parseHTML(file) {
 	};
 }
 
+function isValidUrl(url) {
+	try {
+		new URL(url);
+		return true;
+	} catch (err) {
+		return false;
+	}
+}
+
 function readFile(filePath) {
 	return readFileSync(filePath, { encoding: 'utf8' });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "para-cli",
-  "version": "1.18.7",
+  "version": "1.19.1",
   "license": "Apache-2.0",
   "description": "Command-line tool for Para backend servers",
   "homepage": "https://paraio.org",
@@ -24,25 +24,25 @@
     "api"
   ],
   "devDependencies": {
-    "eslint": "^8.19.0"
+    "eslint": "^8.28.0"
   },
   "repository": "Erudika/para-cli",
   "dependencies": {
     "brace-expansion": "^2.0.1",
-    "chalk": "^5.0.1",
-    "conf": "^10.1.2",
+    "chalk": "^5.1.2",
+    "conf": "^10.2.0",
     "exit": "^0.1.2",
     "figlet": "^1.5.2",
     "get-stdin": "^9.0.0",
     "globby": "^13.1.2",
     "htmlparser2": "^8.0.1",
     "jsonwebtoken": "^8.5.1",
-    "meow": "^10.1.3",
+    "meow": "^11.0.0",
     "mime-types": "^2.1.35",
-    "para-client-js": "^1.37.14",
+    "para-client-js": "^1.38.0",
     "resolve": "^1.22.1",
     "striptags": "^3.2.0",
     "update-notifier": "^6.0.2",
-    "yargs-parser": "^21.0.1"
+    "yargs-parser": "^21.1.1"
   }
 }

package/para-cli.js

@@ -27,7 +27,10 @@ import Conf from 'conf';
 import figlet from 'figlet';
 import chalk from 'chalk';
 import meow from 'meow';
-import { defaultConfig, setup, listApps, selectApp, createAll, readAll, updateAll, deleteAll, search, newKeys, newJWT, newApp, ping, me, appSettings, rebuildIndex, exportData, importData } from './index.js';
+import {
+	defaultConfig, setup, listApps, selectEndpoint, addEndpoint, removeEndpoint, selectApp, createAll, readAll,
+	updateAll, deleteAll, search, newKeys, newJWT, newApp, ping, me, appSettings, rebuildIndex, exportData, importData
+} from './index.js';
 
 const { red, green, blue } = chalk;
 const { textSync } = figlet;
@@ -40,6 +43,7 @@ var cli = meow(`
 	  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.
+	  endpoints [add|remove]                 List and select Para server endpoints, add new or remove an exiting one.
 	  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)
@@ -82,7 +86,9 @@ var cli = meow(`
 	  $ para-cli search "*" --type article --page all
 	  $ para-cli new-key
 	  $ para-cli new-app "mynewapp" --name "Full app name"
-
+	  $ para-cli apps
+	  $ para-cli select scoold
+	  $ para-cli endpoints
 `, {
 	importMeta: import.meta,
 	flags: {
@@ -111,12 +117,14 @@ var selectedApp = config.get('selectedApp');
 if (!flags.accessKey && !flags.secretKey && selectedApp && selectedApp.accessKey && selectedApp.accessKey.indexOf("app:") === 0) {
 	accessKey = selectedApp.accessKey;
 	secretKey = selectedApp.secretKey;
+	endpoint = selectedApp.endpoint;
 }
 
 if (!input[0]) {
 	console.log(help);
 } else if (!accessKey || !secretKey) {
 	console.error(red('Command ' + input[0] + ' failed! Blank credentials, running setup first...'));
+	console.log("Please enter the access key and secret key for the root app 'app:para' first.");
 	process.exitCode = 1;
 	setup(config);
 } else {
@@ -130,8 +138,18 @@ if (!input[0]) {
 		listApps(config, flags, accessKey, function () {console.log('No apps found within', green(accessKey));});
 	}
 
+	if (input[0] === 'endpoints') {
+		if (input.length > 1 && input[1] === 'add') {
+			addEndpoint(config);
+		} else if (input.length > 1 && input[1] === 'remove') {
+			removeEndpoint(config, flags);
+		} else {
+			selectEndpoint(config, flags);
+		}
+	}
+
 	if (input[0] === 'select') {
-		selectApp(pc, input, config, flags);
+		selectApp(input, config, flags);
 	}
 
 	if (input[0] === 'create') {