@govuk-pay/cli 0.0.30 → 0.0.32

package/src/commands/local/subcommands/user.js

@@ -0,0 +1,91 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const app_client_js_1 = __importDefault(require("../app_client/app_client.js"));
+const totp_generator_1 = require("totp-generator");
+const node_child_process_1 = require("node:child_process");
+async function UserHandler(options) {
+    const args = parseArguments(options);
+    if (await app_client_js_1.default.isUnhealthy('adminusers')) {
+        console.error('The adminusers service is unhealthy, so a user cannot be created');
+        return;
+    }
+    if (await app_client_js_1.default.isUnhealthy('connector')) {
+        console.error('The connector service is unhealthy, so a user cannot be created');
+        return;
+    }
+    console.warn('Creating card gateway account and API token');
+    const serviceExternalID = await app_client_js_1.default.createService();
+    if (serviceExternalID === undefined) {
+        console.error('Service creation failed');
+        return;
+    }
+    const account = await app_client_js_1.default.createAccountInServiceWithEmailCollectionMode(serviceExternalID, 'MANDATORY');
+    if (account === undefined) {
+        console.error('Failed to create a fully set up account');
+        return;
+    }
+    const apiToken = await app_client_js_1.default.createToken(account.gateway_account_id);
+    if (apiToken === undefined) {
+        console.error('Failed to create an API token');
+        return;
+    }
+    if (args.createPayments !== undefined && args.createPayments) {
+        console.warn('💸  Creating 10 payments in card sandbox gateway account (each . is a success, each ! is a failure)');
+        let createPaymentResult;
+        for (let i = 0; i < 10; i++) {
+            createPaymentResult = await app_client_js_1.default.createPayment(apiToken);
+            if (createPaymentResult === undefined) {
+                process.stderr.write('!');
+            }
+            else {
+                process.stderr.write('.');
+            }
+        }
+    }
+    console.warn('🤓  Creating admin user for service');
+    const user = await app_client_js_1.default.createUser([account.gateway_account_id], 'admin');
+    if (user === undefined) {
+        console.error('Failed to create an admin user');
+        return;
+    }
+    console.warn('😎  Creating view-only user for service');
+    const viewOnlyUser = await app_client_js_1.default.createUser([account.gateway_account_id], 'view-only');
+    if (viewOnlyUser === undefined) {
+        console.error('Failed to create a view-only user, continuing anyway since the admin user was successfully created');
+    }
+    const { otp } = totp_generator_1.TOTP.generate(user.otp_key);
+    console.log(`📧  Email: ${user.email}`);
+    console.log(`🛂  Password: ${user.password}`);
+    console.log(`🔑  OTP key: ${user.otp_key}`);
+    console.log(`📱  OTP token: ${otp}`);
+    console.log(`💁  Service ID: ${serviceExternalID}`);
+    console.log(`💳  Card gateway account ID: ${account.external_id}`);
+    console.log(`🎫  Card API token: ${apiToken}`);
+    console.log();
+    let selfserviceUrl;
+    if (await app_client_js_1.default.isProxyHealthy('selfservice')) {
+        selfserviceUrl = app_client_js_1.default.externalUrlFor('selfservice', '/', true);
+    }
+    else {
+        selfserviceUrl = app_client_js_1.default.externalUrlFor('selfservice', '/', false);
+    }
+    copyToClipboard(user.email);
+    console.log(`📋 “${user.email}” copied to clipboard`);
+    console.log(`🌎 Opening selfservice (${selfserviceUrl}) browser`);
+    console.log();
+    (0, node_child_process_1.spawn)('open', [selfserviceUrl]);
+}
+exports.default = UserHandler;
+function copyToClipboard(email) {
+    const proc = (0, node_child_process_1.spawn)('pbcopy');
+    proc.stdin.write(email);
+    proc.stdin.end();
+}
+function parseArguments(_options) {
+    return {
+        createPayments: false
+    };
+}

package/src/commands/local.js

@@ -0,0 +1,136 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const standardContent_js_1 = require("../core/standardContent.js");
+const otp_js_1 = __importDefault(require("./local/subcommands/otp.js"));
+const up_js_1 = __importDefault(require("./local/subcommands/up.js"));
+const down_js_1 = __importDefault(require("./local/subcommands/down.js"));
+const nuke_js_1 = __importDefault(require("./local/subcommands/nuke.js"));
+const restart_js_1 = __importDefault(require("./local/subcommands/restart.js"));
+const paymentlink_js_1 = __importDefault(require("./local/subcommands/paymentlink.js"));
+const url_js_1 = __importDefault(require("./local/subcommands/url.js"));
+const browse_js_1 = __importDefault(require("./local/subcommands/browse.js"));
+const db_js_1 = __importDefault(require("./local/subcommands/db.js"));
+const account_js_1 = __importDefault(require("./local/subcommands/account.js"));
+const token_js_1 = __importDefault(require("./local/subcommands/token.js"));
+const payment_js_1 = __importDefault(require("./local/subcommands/payment.js"));
+const user_js_1 = __importDefault(require("./local/subcommands/user.js"));
+var LocalCommand;
+(function (LocalCommand) {
+    LocalCommand["OTP"] = "otp";
+    LocalCommand["Up"] = "up";
+    LocalCommand["Launch"] = "launch";
+    LocalCommand["Down"] = "down";
+    LocalCommand["Restart"] = "restart";
+    LocalCommand["Nuke"] = "nuke";
+    LocalCommand["PaymentLink"] = "paymentlink";
+    LocalCommand["Browse"] = "browse";
+    LocalCommand["Url"] = "url";
+    LocalCommand["DB"] = "db";
+    LocalCommand["Token"] = "token";
+    LocalCommand["Payment"] = "payment";
+    LocalCommand["Account"] = "account";
+    LocalCommand["User"] = "user";
+    LocalCommand["Help"] = "help";
+    LocalCommand["Unknown"] = "Unknown";
+})(LocalCommand || (LocalCommand = {}));
+async function localHandler(options) {
+    await (0, standardContent_js_1.showHeader)();
+    const { subcommand, subcommandOptions } = parseArguments(options);
+    switch (subcommand) {
+        case LocalCommand.OTP: {
+            await (0, otp_js_1.default)(subcommandOptions);
+            break;
+        }
+        case LocalCommand.PaymentLink: {
+            await (0, paymentlink_js_1.default)(subcommandOptions);
+            break;
+        }
+        case LocalCommand.Browse: {
+            await (0, browse_js_1.default)(subcommandOptions);
+            break;
+        }
+        case LocalCommand.Account: {
+            await (0, account_js_1.default)(subcommandOptions);
+            break;
+        }
+        case LocalCommand.Url: {
+            await (0, url_js_1.default)(subcommandOptions);
+            break;
+        }
+        case LocalCommand.DB: {
+            await (0, db_js_1.default)(subcommandOptions);
+            break;
+        }
+        case LocalCommand.Token: {
+            await (0, token_js_1.default)(subcommandOptions);
+            break;
+        }
+        case LocalCommand.Payment: {
+            await (0, payment_js_1.default)(subcommandOptions);
+            break;
+        }
+        case LocalCommand.User: {
+            await (0, user_js_1.default)(subcommandOptions);
+            break;
+        }
+        case LocalCommand.Up: {
+            await (0, up_js_1.default)(subcommandOptions);
+            break;
+        }
+        case LocalCommand.Launch: {
+            await (0, up_js_1.default)(subcommandOptions);
+            break;
+        }
+        case LocalCommand.Down: {
+            await (0, down_js_1.default)(subcommandOptions);
+            break;
+        }
+        case LocalCommand.Restart: {
+            await (0, restart_js_1.default)(subcommandOptions);
+            break;
+        }
+        case LocalCommand.Nuke: {
+            await (0, nuke_js_1.default)();
+            break;
+        }
+        case LocalCommand.Help:
+        case LocalCommand.Unknown: {
+            help();
+            break;
+        }
+        default: {
+            help();
+            break;
+        }
+    }
+}
+exports.default = localHandler;
+// TODO: Replace this with yargs
+function parseArguments(options) {
+    const subcommandOptions = options.arguments;
+    const subcommand = subcommandOptions.shift();
+    switch (subcommand) {
+        case LocalCommand.OTP: return { subcommand, subcommandOptions };
+        case LocalCommand.PaymentLink: return { subcommand, subcommandOptions };
+        case LocalCommand.Url: return { subcommand, subcommandOptions };
+        case LocalCommand.Browse: return { subcommand, subcommandOptions };
+        case LocalCommand.Account: return { subcommand, subcommandOptions };
+        case LocalCommand.Up: return { subcommand, subcommandOptions };
+        case LocalCommand.DB: return { subcommand, subcommandOptions };
+        case LocalCommand.Token: return { subcommand, subcommandOptions };
+        case LocalCommand.Payment: return { subcommand, subcommandOptions };
+        case LocalCommand.User: return { subcommand, subcommandOptions };
+        case LocalCommand.Launch: return { subcommand, subcommandOptions };
+        case LocalCommand.Down: return { subcommand, subcommandOptions };
+        case LocalCommand.Restart: return { subcommand, subcommandOptions };
+        case LocalCommand.Nuke: return { subcommand, subcommandOptions };
+        case LocalCommand.Help: return { subcommand, subcommandOptions };
+        default: return { subcommand: LocalCommand.Unknown, subcommandOptions };
+    }
+}
+function help() {
+    console.error('USAGE FOLLOWS');
+}

package/src/core/commandRouter.js

@@ -7,6 +7,7 @@ const standardContent_js_1 = require("./standardContent.js");
 const browse_js_1 = __importDefault(require("../commands/browse.js"));
 const demo_js_1 = __importDefault(require("../commands/demo.js"));
 const legacy_1 = __importDefault(require("../commands/legacy"));
+const local_js_1 = __importDefault(require("../commands/local.js"));
 const help_1 = __importDefault(require("../commands/help"));
 const tunnel_js_1 = __importDefault(require("../commands/tunnel.js"));
 const package_json_1 = __importDefault(require("../../package.json"));
@@ -30,6 +31,9 @@ handlers.set('help', {
 handlers.set('local', {
     handler: legacy_1.default
 });
+handlers.set('localx', {
+    handler: local_js_1.default
+});
 handlers.set('schema', {
     handler: legacy_1.default
 });

package/src/util/configs.js

@@ -0,0 +1,47 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.workspaceEnvVar = exports.ensureConfigDirectory = exports.PAY_CLI_CONFIG_PATH = void 0;
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_os_1 = require("node:os");
+const node_path_1 = __importDefault(require("node:path"));
+exports.PAY_CLI_CONFIG_PATH = node_path_1.default.join((0, node_os_1.homedir)(), '.pay-cli');
+/**
+ * This function validates a config path within the pay cli config dir exists, if it does then it creates it.
+ * It does this by joining all the subPath param elements onto the end of the default config path
+ * using path.join.
+ *
+ * Returns the absolute file path
+ */
+function ensureConfigDirectory(...subPath) {
+    const fullConfigDirPath = node_path_1.default.resolve(node_path_1.default.join(exports.PAY_CLI_CONFIG_PATH, ...subPath));
+    const configPathStat = node_fs_1.default.statSync(fullConfigDirPath, { throwIfNoEntry: false });
+    if (configPathStat === undefined) {
+        node_fs_1.default.mkdirSync(fullConfigDirPath, { mode: 0o770, recursive: true });
+    }
+    else if (!configPathStat.isDirectory()) {
+        throw new Error(`pay local config path ${fullConfigDirPath} already exists and is not a directory, cannot continue`);
+    }
+    return fullConfigDirPath;
+}
+exports.ensureConfigDirectory = ensureConfigDirectory;
+/**
+ * This function validates the the WORKSPACE env var is set, and that it is directory that exists.
+ */
+function workspaceEnvVar() {
+    const workspacePath = process.env.WORKSPACE;
+    if (workspacePath === undefined) {
+        throw new Error('Error, the WORKSPACE env var must be set to the parent directory of where you check out your pay repositories');
+    }
+    const workspacePathStat = node_fs_1.default.statSync(workspacePath, { throwIfNoEntry: false });
+    if (workspacePathStat === undefined) {
+        throw new Error(`Error, the WORKSPACE env var is set to '${workspacePath}' which doesn't exist. This must be set to the parent directory of where you check out your pay repositories`);
+    }
+    if (!workspacePathStat.isDirectory()) {
+        throw new Error(`Error, the WORKSPACE env var is set to '${workspacePath}' which exists, but is not a directory. This must be set to the parent directory of where you check out your pay repositories`);
+    }
+    return workspacePath;
+}
+exports.workspaceEnvVar = workspaceEnvVar;

package/src/util/md5.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.md5File = exports.md5String = void 0;
+const node_crypto_1 = require("node:crypto");
+const node_fs_1 = require("node:fs");
+function md5String(str) {
+    return md5Of(str);
+}
+exports.md5String = md5String;
+function md5File(filePath) {
+    return md5Of((0, node_fs_1.readFileSync)(filePath));
+}
+exports.md5File = md5File;
+function md5Of(data) {
+    return (0, node_crypto_1.createHash)('md5').update(data).digest('hex');
+}