neonctl 0.3.2 → 0.5.3

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "neonctl",
-    "version": "0.3.2",
+    "version": "0.5.3",
     "description": "CLI tool for NeonDB Cloud management",
     "main": "index.js",
     "author": "NeonDB",
@@ -10,16 +10,20 @@
         "neonctl": "src/cli.js"
     },
     "devDependencies": {
+        "@types/cli-table": "^0.3.0",
         "@types/node": "^18.7.13",
         "@types/yargs": "^17.0.11",
         "@typescript-eslint/eslint-plugin": "^5.34.0",
         "@typescript-eslint/parser": "^5.34.0",
         "eslint": "^8.22.0",
+        "husky": "^8.0.1",
+        "lint-staged": "^13.0.3",
         "prettier": "^2.7.1",
         "ts-node": "^10.9.1",
         "typescript": "^4.7.4"
     },
     "dependencies": {
+        "cli-table": "^0.3.11",
         "open": "^8.4.0",
         "openid-client": "^5.1.9",
         "yargs": "^17.5.1"
@@ -30,10 +34,18 @@
     },
     "scripts": {
         "dev": "node dev.js",
+        "lint": "eslint src --ext .ts",
         "debug": "node --inspect-brk dev.js",
         "build": "npm run clean && tsc && cp src/*.html dist/src/",
         "clean": "rm -rf dist",
         "start": "node index.js",
-        "publizh": "npm run build && cd dist && npm publish"
+        "publizh": "npm run build && npm publish ./dist && git push",
+        "postinstall": "husky install"
+    },
+    "lint-staged": {
+        "*.ts": [
+            "eslint --cache --fix",
+            "prettier --write"
+        ]
     }
 }

package/src/api/gateway.js

@@ -60,7 +60,7 @@ const apiCall = ({ apiHost, token, path, body, method = 'GET', }) => new Promise
             result += data;
         });
         res.on('end', () => {
-            resolve(result);
+            resolve(JSON.parse(result));
         });
     });
     req.on('error', reject);

package/src/api/projects.js

@@ -7,6 +7,7 @@ exports.listProjects = listProjects;
 const createProject = (props) => (0, gateway_1.apiCall)(Object.assign(Object.assign({}, props), { body: {
         project: {
             settings: props.settings,
+            name: props.name,
         },
     }, path: 'projects', method: 'POST' }));
 exports.createProject = createProject;

package/src/auth.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.auth = void 0;
+exports.auth = exports.refreshToken = void 0;
 const openid_client_1 = require("openid-client");
 const node_http_1 = require("node:http");
 const node_fs_1 = require("node:fs");
@@ -24,11 +24,30 @@ const SERVER_TIMEOUT = 10000;
 // where to wait for incoming redirect request from oauth server to arrive
 const REDIRECT_URI = (port) => `http://127.0.0.1:${port}/callback`;
 // These scopes cannot be cancelled, they are always needed.
-const DEFAULT_SCOPES = ['openid', 'offline', 'urn:neoncloud:projects:create'];
-const auth = ({ oauthHost, clientId }) => __awaiter(void 0, void 0, void 0, function* () {
-    openid_client_1.custom.setHttpOptionsDefaults({
-        timeout: SERVER_TIMEOUT,
+const DEFAULT_SCOPES = [
+    'openid',
+    'offline',
+    'offline_access',
+    'urn:neoncloud:projects:create',
+    'urn:neoncloud:projects:read',
+    'urn:neoncloud:projects:modify',
+    'urn:neoncloud:projects:delete',
+];
+openid_client_1.custom.setHttpOptionsDefaults({
+    timeout: SERVER_TIMEOUT,
+});
+const refreshToken = ({ oauthHost, clientId }, tokenSet) => __awaiter(void 0, void 0, void 0, function* () {
+    log_1.log.info('Discovering oauth server');
+    const issuer = yield openid_client_1.Issuer.discover(oauthHost);
+    const neonOAuthClient = new issuer.Client({
+        token_endpoint_auth_method: 'none',
+        client_id: clientId,
+        response_types: ['code'],
     });
+    return yield neonOAuthClient.refresh(tokenSet);
+});
+exports.refreshToken = refreshToken;
+const auth = ({ oauthHost, clientId }) => __awaiter(void 0, void 0, void 0, function* () {
     log_1.log.info('Discovering oauth server');
     const issuer = yield openid_client_1.Issuer.discover(oauthHost);
     //

package/src/commands/auth.js

@@ -35,8 +35,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ensureAuth = exports.authFlow = void 0;
 const node_path_1 = require("node:path");
 const node_fs_1 = require("node:fs");
+const openid_client_1 = require("openid-client");
 const auth_1 = require("../auth");
 const log_1 = require("../log");
+const users_1 = require("../api/users");
+const gateway_1 = require("../api/gateway");
 const CREDENTIALS_FILE = 'credentials.json';
 const authFlow = ({ 'config-dir': configDir, 'oauth-host': oauthHost, 'client-id': clientId, }) => __awaiter(void 0, void 0, void 0, function* () {
     if (!clientId) {
@@ -47,12 +50,30 @@ const authFlow = ({ 'config-dir': configDir, 'oauth-host': oauthHost, 'client-id
         clientId: clientId,
     });
     const credentialsPath = (0, node_path_1.join)(configDir, CREDENTIALS_FILE);
-    (0, node_fs_1.writeFileSync)(credentialsPath, JSON.stringify(tokenSet));
+    updateCredentialsFile(credentialsPath, JSON.stringify(tokenSet));
     log_1.log.info(`Saved credentials to ${credentialsPath}`);
     log_1.log.info('Auth complete');
     return tokenSet.access_token || '';
 });
 exports.authFlow = authFlow;
+const validateToken = (props) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        yield (0, users_1.apiMe)(props);
+    }
+    catch (e) {
+        if (e instanceof gateway_1.ApiError) {
+            if (e.response.statusCode === 401) {
+                throw new Error('Invalid token');
+            }
+        }
+    }
+});
+// updateCredentialsFile correctly sets needed permissions for the credentials file
+function updateCredentialsFile(path, contents) {
+    (0, node_fs_1.writeFileSync)(path, contents, {
+        mode: 0o700,
+    });
+}
 const ensureAuth = (props) => __awaiter(void 0, void 0, void 0, function* () {
     if (props.token || props._[0] === 'auth') {
         return;
@@ -60,16 +81,33 @@ const ensureAuth = (props) => __awaiter(void 0, void 0, void 0, function* () {
     const credentialsPath = (0, node_path_1.join)(props['config-dir'], CREDENTIALS_FILE);
     if ((0, node_fs_1.existsSync)(credentialsPath)) {
         try {
-            const token = (yield Promise.resolve().then(() => __importStar(require(credentialsPath)))).access_token;
+            const tokenSetContents = yield Promise.resolve().then(() => __importStar(require(credentialsPath)));
+            const tokenSet = new openid_client_1.TokenSet(tokenSetContents);
+            if (tokenSet.expired()) {
+                log_1.log.info('using refresh token to update access token');
+                const refreshedTokenSet = yield (0, auth_1.refreshToken)({
+                    oauthHost: props['oauth-host'],
+                    clientId: props['client-id'],
+                }, tokenSet);
+                props.token = refreshedTokenSet.access_token || 'UNKNOWN';
+                updateCredentialsFile(credentialsPath, JSON.stringify(refreshedTokenSet));
+                return;
+            }
+            const token = tokenSet.access_token || 'UNKNOWN';
+            yield validateToken({ apiHost: props['api-host'], token });
             props.token = token;
             return;
         }
         catch (e) {
-            yield (0, exports.authFlow)(props);
+            if (e.code !== 'ENOENT') {
+                // not a "file does not exist" error
+                throw e;
+            }
+            props.token = yield (0, exports.authFlow)(props);
         }
     }
     else {
-        yield (0, exports.authFlow)(props);
+        props.token = yield (0, exports.authFlow)(props);
     }
 });
 exports.ensureAuth = ensureAuth;

package/src/commands/projects.js

@@ -11,11 +11,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.create = exports.list = void 0;
 const projects_1 = require("../api/projects");
+const writer_1 = require("../writer");
 const list = (props) => __awaiter(void 0, void 0, void 0, function* () {
-    process.stdout.write(yield (0, projects_1.listProjects)(props));
+    (0, writer_1.writeOut)(props)(yield (0, projects_1.listProjects)(props), { fields: [] });
 });
 exports.list = list;
 const create = (props) => __awaiter(void 0, void 0, void 0, function* () {
-    process.stdout.write(yield (0, projects_1.createProject)(Object.assign(Object.assign({}, props), { settings: {} })));
+    (0, writer_1.writeOut)(props)(yield (0, projects_1.createProject)(Object.assign(Object.assign({}, props), { settings: {}, name: props.name })), { fields: ['id', 'name', 'region_name', 'created_at'] });
 });
 exports.create = create;

package/src/commands/users.js

@@ -11,7 +11,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.me = void 0;
 const users_1 = require("../api/users");
+const writer_1 = require("../writer");
 const me = (props) => __awaiter(void 0, void 0, void 0, function* () {
-    process.stdout.write(yield (0, users_1.apiMe)(props));
+    (0, writer_1.writeOut)(props)(yield (0, users_1.apiMe)(props), {
+        fields: ['login', 'email', 'name', 'projects_limit'],
+    });
 });
 exports.me = me;

package/src/config.js

@@ -11,9 +11,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ensureConfigDir = exports.defaultDir = void 0;
 const node_path_1 = require("node:path");
+const node_os_1 = require("node:os");
 const node_fs_1 = require("node:fs");
 const DIR_NAME = '.neonctl';
-exports.defaultDir = (0, node_path_1.join)(process.cwd(), DIR_NAME);
+const cwdDir = (0, node_path_1.join)(process.cwd(), DIR_NAME);
+const homeConfigDir = (0, node_path_1.join)((0, node_os_1.homedir)(), process.env.XDG_CONFIG_HOME || '.config', DIR_NAME);
+exports.defaultDir = (0, node_fs_1.existsSync)(cwdDir) ? cwdDir : homeConfigDir;
 const ensureConfigDir = ({ 'config-dir': configDir, }) => __awaiter(void 0, void 0, void 0, function* () {
     if (!(0, node_fs_1.existsSync)(configDir)) {
         (0, node_fs_1.mkdirSync)(configDir);

package/src/index.js

@@ -44,6 +44,7 @@ const log_1 = require("./log");
 const showHelpMiddleware = (argv) => {
     if (argv._.length === 1) {
         yargs.showHelp();
+        process.exit(0);
     }
 };
 const builder = yargs
@@ -84,8 +85,7 @@ const builder = yargs
     type: 'string',
     default: '',
 })
-    .middleware(auth_1.ensureAuth)
-    .command('me', 'Get user info', (yargs) => yargs, (args) => __awaiter(void 0, void 0, void 0, function* () {
+    .command('me', 'Get user info', (yargs) => yargs.middleware(auth_1.ensureAuth), (args) => __awaiter(void 0, void 0, void 0, function* () {
     yield (yield Promise.resolve().then(() => __importStar(require('./commands/users')))).me(args);
 }))
     .command('projects', 'Manage projects', (yargs) => __awaiter(void 0, void 0, void 0, function* () {
@@ -99,10 +99,14 @@ const builder = yargs
         //     await (await import('./commands/projects')).list(args);
         //   }
         // )
-        .command('create', 'Create a project', (yargs) => yargs, (args) => __awaiter(void 0, void 0, void 0, function* () {
+        .command('create', 'Create a project', (yargs) => yargs.option('name', {
+        describe: 'Project name',
+        type: 'string',
+    }), (args) => __awaiter(void 0, void 0, void 0, function* () {
         yield (yield Promise.resolve().then(() => __importStar(require('./commands/projects')))).create(args);
     }))
-        .middleware(showHelpMiddleware);
+        .middleware(showHelpMiddleware)
+        .middleware(auth_1.ensureAuth);
 }))
     .strict()
     .fail((msg, err) => __awaiter(void 0, void 0, void 0, function* () {
@@ -118,5 +122,6 @@ const builder = yargs
     const args = yield builder.argv;
     if (args._.length === 0) {
         yargs.showHelp();
+        process.exit(0);
     }
 }))();

package/src/writer.js

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.writeOut = void 0;
+const cli_table_1 = __importDefault(require("cli-table"));
+const writeOut = (props) => (data, config) => {
+    if (props.json) {
+        process.stdout.write(JSON.stringify(data, null, 2));
+        return;
+    }
+    const arrayData = Array.isArray(data) ? data : [data];
+    const table = new cli_table_1.default({
+        style: {
+            head: ['green'],
+        },
+        head: config.fields.map((field) => field
+            .split('_')
+            .map((word) => word[0].toUpperCase() + word.slice(1))
+            .join(' ')),
+    });
+    arrayData.forEach((item) => {
+        table.push(config.fields.map((field) => { var _a; return (_a = item[field]) !== null && _a !== void 0 ? _a : ''; }));
+    });
+    process.stdout.write(table.toString());
+    process.stdout.write('\n');
+};
+exports.writeOut = writeOut;