neonctl 0.0.1 → 0.0.2

package/package.json

@@ -1,11 +1,32 @@
 {
-  "name": "neonctl",
-  "version": "0.0.1",
-  "description": "",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "author": "Eduard Dyckman",
-  "license": "ISC"
+    "name": "neonctl",
+    "version": "0.0.2",
+    "description": "CLI tool for NeonDB Cloud management",
+    "main": "index.js",
+    "author": "NeonDB",
+    "license": "MIT",
+    "private": false,
+    "devDependencies": {
+        "@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",
+        "prettier": "^2.7.1",
+        "ts-node": "^10.9.1",
+        "typescript": "^4.7.4"
+    },
+    "dependencies": {
+        "open": "^8.4.0",
+        "openid-client": "^5.1.9",
+        "yargs": "^17.5.1"
+    },
+    "scripts": {
+        "dev": "node dev.js",
+        "debug": "node --inspect-brk dev.js",
+        "build": "tsc",
+        "clean": "rm -rf dist",
+        "start": "node index.js",
+        "publish": "yarn build && cd dist && npm publish"
+    }
 }

package/src/api/gateway.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.apiCall = void 0;
+const https_1 = require("https");
+const apiCall = ({ apiHost, token, path, body, method = 'GET', }) => new Promise((resolve, reject) => {
+    const req = (0, https_1.request)(`${apiHost}/api/v1/${path}`, {
+        headers: {
+            Authorization: `Bearer ${token}`,
+            Accept: 'application/json',
+            'Content-Type': 'application/json',
+        },
+        method,
+    }, (res) => {
+        if (res.statusCode !== 200) {
+            reject(new Error(`${res.statusCode}: ${res.statusMessage}`));
+            return;
+        }
+        let result = '';
+        res.on('data', (data) => {
+            result += data;
+        });
+        res.on('end', () => {
+            resolve(result);
+        });
+    });
+    req.on('error', reject);
+    if (body) {
+        req.write(JSON.stringify(body));
+    }
+    req.end();
+});
+exports.apiCall = apiCall;

package/src/api/projects.js

@@ -0,0 +1,23 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createProject = exports.listProjects = void 0;
+const gateway_1 = require("./gateway");
+const listProjects = (props) => __awaiter(void 0, void 0, void 0, function* () { return (0, gateway_1.apiCall)(Object.assign(Object.assign({}, props), { path: 'projects', method: 'GET' })); });
+exports.listProjects = listProjects;
+const createProject = (props) => __awaiter(void 0, void 0, void 0, function* () {
+    return (0, gateway_1.apiCall)(Object.assign(Object.assign({}, props), { body: {
+            instance_handle: props.instanceHandle,
+            platform_id: props.platformId,
+            region_id: props.regionId,
+        }, path: 'projects', method: 'POST' }));
+});
+exports.createProject = createProject;

package/src/auth.js

@@ -0,0 +1,87 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.auth = void 0;
+const openid_client_1 = require("openid-client");
+const node_http_1 = require("node:http");
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const open_1 = __importDefault(require("open"));
+const log_1 = require("./log");
+// what port to listen on for incoming requests
+const CONFIG_LISTEN_PORT = 5555;
+// oauth server timeouts
+const SERVER_TIMEOUT = 10000;
+// where to wait for incoming redirect request from oauth server to arrive
+const REDIRECT_URI = 'http://127.0.0.1:5555/callback';
+// These scopes cannot be cancelled, they are always needed.
+const DEFAULT_SCOPES = ['openid', 'offline'];
+const auth = ({ oauthHost, clientId }) => __awaiter(void 0, void 0, void 0, function* () {
+    openid_client_1.custom.setHttpOptionsDefaults({
+        timeout: SERVER_TIMEOUT,
+    });
+    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,
+        redirect_uris: [REDIRECT_URI],
+        response_types: ['code'],
+    });
+    // https://datatracker.ietf.org/doc/html/rfc6819#section-4.4.1.8
+    const state = openid_client_1.generators.state();
+    // we store the code_verifier in memory
+    const codeVerifier = openid_client_1.generators.codeVerifier();
+    const codeChallenge = openid_client_1.generators.codeChallenge(codeVerifier);
+    return new Promise((resolve) => {
+        //
+        // Start HTTP server and wait till /callback is hit
+        //
+        const server = (0, node_http_1.createServer)((request, response) => __awaiter(void 0, void 0, void 0, function* () {
+            var _a;
+            //
+            // Wait for callback and follow oauth flow.
+            //
+            if (!((_a = request.url) === null || _a === void 0 ? void 0 : _a.startsWith('/callback'))) {
+                response.writeHead(404);
+                response.end();
+                return;
+            }
+            log_1.log.info(`Callback received: ${request.url}`);
+            const params = neonOAuthClient.callbackParams(request);
+            const tokenSet = yield neonOAuthClient.callback(REDIRECT_URI, params, {
+                code_verifier: codeVerifier,
+                state,
+            });
+            response.writeHead(200, { 'Content-Type': 'text/html' });
+            (0, node_fs_1.createReadStream)((0, node_path_1.join)(__dirname, './callback.html')).pipe(response);
+            resolve(tokenSet);
+            server.close();
+        }));
+        server.listen(CONFIG_LISTEN_PORT, () => {
+            log_1.log.info(`Listening on port ${CONFIG_LISTEN_PORT}`);
+        });
+        //
+        // Open browser to let user authenticate
+        //
+        const authUrl = neonOAuthClient.authorizationUrl({
+            scope: DEFAULT_SCOPES.join(' '),
+            state,
+            code_challenge: codeChallenge,
+            code_challenge_method: 'S256',
+        });
+        (0, open_1.default)(authUrl);
+    });
+});
+exports.auth = auth;

package/src/commands/auth.js

@@ -0,0 +1,85 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureAuth = exports.validateAuth = exports.authFlow = void 0;
+const node_path_1 = require("node:path");
+const node_fs_1 = require("node:fs");
+const auth_1 = require("../auth");
+const projects_1 = require("../api/projects");
+const log_1 = require("../log");
+const CREDENTIALS_FILE = 'credentials.json';
+const authFlow = ({ configDir, oauthHost, clientId, }) => __awaiter(void 0, void 0, void 0, function* () {
+    if (!clientId) {
+        throw new Error('Missing client id');
+    }
+    const tokenSet = yield (0, auth_1.auth)({
+        oauthHost: oauthHost,
+        clientId: clientId,
+    });
+    const credentialsPath = (0, node_path_1.join)(configDir, CREDENTIALS_FILE);
+    (0, node_fs_1.writeFileSync)(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 validateAuth = (props) => __awaiter(void 0, void 0, void 0, function* () {
+    try {
+        yield (0, projects_1.listProjects)(props);
+    }
+    catch (e) {
+        if (e.message.startsWith('401:')) {
+            return false;
+        }
+        throw e;
+    }
+    return true;
+});
+exports.validateAuth = validateAuth;
+const ensureAuth = (props) => __awaiter(void 0, void 0, void 0, function* () {
+    const credentialsPath = (0, node_path_1.join)(props.configDir, CREDENTIALS_FILE);
+    if ((0, node_fs_1.existsSync)(credentialsPath)) {
+        const token = (yield Promise.resolve().then(() => __importStar(require(credentialsPath)))).access_token;
+        if (yield (0, exports.validateAuth)(Object.assign(Object.assign({}, props), { token }))) {
+            props.token = token;
+        }
+        else {
+            props.token = yield (0, exports.authFlow)(props);
+        }
+    }
+    else {
+        props.token = yield (0, exports.authFlow)(props);
+    }
+});
+exports.ensureAuth = ensureAuth;

package/src/commands/projects.js

@@ -0,0 +1,20 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const projects_1 = require("../api/projects");
+exports.default = (props) => __awaiter(void 0, void 0, void 0, function* () {
+    if (props.sub === 'list' || props.sub === undefined) {
+        process.stdout.write(yield (0, projects_1.listProjects)(props));
+    }
+    else if (props.sub === 'create') {
+        process.stdout.write(yield (0, projects_1.createProject)(Object.assign(Object.assign({}, props), { instanceHandle: 'scalable', platformId: 'serverless', regionId: 'us-west-2' })));
+    }
+});

package/src/config.js

@@ -0,0 +1,22 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureConfigDir = exports.defaultDir = void 0;
+const node_path_1 = require("node:path");
+const node_fs_1 = require("node:fs");
+const DIR_NAME = '.neonctl';
+exports.defaultDir = (0, node_path_1.join)(process.cwd(), DIR_NAME);
+const ensureConfigDir = ({ configDir, }) => __awaiter(void 0, void 0, void 0, function* () {
+    if (!(0, node_fs_1.existsSync)(configDir)) {
+        (0, node_fs_1.mkdirSync)(configDir);
+    }
+});
+exports.ensureConfigDir = ensureConfigDir;

package/src/index.js

@@ -0,0 +1,88 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const yargs = __importStar(require("yargs"));
+const package_json_1 = __importDefault(require("../package.json"));
+const auth_1 = require("./commands/auth");
+const config_1 = require("./config");
+const builder = yargs
+    .scriptName(package_json_1.default.name)
+    .usage('$0 <cmd> [args]')
+    .help()
+    .option('apiHost', {
+    describe: 'The API host',
+    default: 'https://console.neon.tech',
+})
+    .option('oauthHost', {
+    description: 'URL to Neon OAUTH host',
+    default: 'https://oauth2.neon.tech',
+})
+    .option('clientId', {
+    description: 'OAuth client id',
+    type: 'string',
+})
+    // Setup config directory
+    .option('configDir', {
+    describe: 'Path to config directory',
+    type: 'string',
+    default: config_1.defaultDir,
+})
+    .middleware(config_1.ensureConfigDir)
+    // Auth flow
+    .command('auth', 'Authenticate user', (yargs) => yargs, (args) => __awaiter(void 0, void 0, void 0, function* () {
+    (yield Promise.resolve().then(() => __importStar(require('./commands/auth')))).authFlow(args);
+}))
+    // Ensure auth token
+    .option('token', {
+    describe: 'Auth token',
+    type: 'string',
+    default: '',
+})
+    .middleware(auth_1.ensureAuth)
+    .command('projects [sub]', 'Manage projects', (yargs) => __awaiter(void 0, void 0, void 0, function* () {
+    return yargs.positional('sub', {
+        describe: 'Subcommand',
+        choices: ['list', 'create'],
+    });
+}), (args) => __awaiter(void 0, void 0, void 0, function* () {
+    (yield Promise.resolve().then(() => __importStar(require('./commands/projects')))).default(args);
+}));
+(() => __awaiter(void 0, void 0, void 0, function* () {
+    if ((yield builder.argv)._.length === 0) {
+        yargs.showHelp();
+    }
+}))();

package/src/log.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.log = void 0;
+exports.log = {
+    info: (message) => {
+        process.stderr.write(`${message}\n`);
+    },
+};