@govuk-pay/cli 0.0.31 → 0.0.33

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@govuk-pay/cli",
-  "version": "0.0.31",
+  "version": "0.0.33",
   "description": "GOV.UK Pay Command Line Interface",
   "bin": {
     "pay": "bin/cli.js",
@@ -22,8 +22,8 @@
     "openurl": "^1.1.1",
     "semver": "^7.6.3",
     "totp-generator": "^1.0.0",
-    "ts-standard": "^12.0.2",
-    "yaml": "^2.5.1"
+    "yaml": "^2.5.1",
+    "yargs": "^17.7.2"
   },
   "files": [
     "resources",

package/resources/pay-local/templates/docker-compose.hbs

@@ -146,6 +146,9 @@ services:
     {{#ifBoth ../mountLocalNodeApps localBuild}}
     volumes:
       - "$WORKSPACE/pay-{{../name}}:/app"
+      {{#if ../../mountPayJSCommons}}
+      - "$WORKSPACE/pay-js-commons:/pay-js-commons"
+      {{/if}}
     {{/ifBoth}}
     environment:
       - BIND_HOST=0.0.0.0
@@ -178,7 +181,7 @@ services:
     {{#ifBoth localBuild entrypointOverrideLocal}}
     entrypoint: {{{../entrypointOverrideLocal}}}
     {{else}}
-    entrypoint: "npx nodemon --inspect=0.0.0.0:{{../debugPort}} start.js"
+    entrypoint: "npx nodemon --inspect=0.0.0.0:{{../debugPort}}"
     {{/ifBoth}}
     ports:
       - "{{port}}:{{port}}"

package/src/commands/browse.js

@@ -1,33 +1,8 @@
 "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;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.logBrowseCommands = void 0;
-const path = __importStar(require("path"));
+exports.handler = exports.builder = exports.desc = exports.command = void 0;
 const standardContent_js_1 = require("../core/standardContent.js");
 const moduleFunctionWrapper_js_1 = require("../util/moduleFunctionWrapper.js");
-const constants_1 = require("../core/constants");
 const requestableItems = new Map();
 requestableItems.set('concourse', {
     name: 'concourse page',
@@ -45,51 +20,25 @@ requestableItems.set('status', {
     name: 'status page',
     url: 'https://payments.statuspage.io/'
 });
-function logBrowseCommands() {
-    console.log(`Commands:
-    pay browse concourse       # browses the concourse page
-    pay browse help [COMMAND]  # Describe subcommands or one specific subcommand
-    pay browse manual          # browses the pay team manual
-    pay browse repo            # browses the pay-infra github repo
-    pay browse status          # browses the pay status page`);
-}
-exports.logBrowseCommands = logBrowseCommands;
-function logNoCommand(argumentName) {
-    console.error(`Could not find command "${argumentName}".`);
-    console.log(`The available options are: "${Array.from(requestableItems.keys()).join('", "')}".`);
-}
-async function browseHandler(options) {
+exports.command = 'browse <location>';
+exports.desc = 'Open a web browser to useful locations';
+const builder = (yargs) => {
+    return yargs.positional('location', {
+        choices: [...requestableItems.keys()]
+    });
+};
+exports.builder = builder;
+exports.handler = browseHandler;
+async function browseHandler(argv) {
+    console.log(argv);
     await (0, standardContent_js_1.showHeader)();
-    if (options.arguments.length === 0) {
-        logBrowseCommands();
-        return;
-    }
-    if (options.arguments[0] === 'help') {
-        const argumentName = options.arguments[1];
-        if (argumentName === undefined || argumentName.trim() === '') {
-            logBrowseCommands();
-            return;
-        }
-        const requestedItem = requestableItems.get(argumentName);
-        if (requestedItem != null) {
-            console.log('Usage:');
-            console.log(`  npx --package=${path.resolve(constants_1.rootDir)} browse ${argumentName}`);
-            console.log(`browses the ${requestedItem.name}`);
-            return;
+    const location = argv.location;
+    const requestedItem = requestableItems.get(location);
+    console.log(`Opening the ${requestedItem.name}`);
+    moduleFunctionWrapper_js_1.moduleFunctionWrapper.open(requestedItem.url, (err) => {
+        if (err != null) {
+            console.log(`Failed to open browser, please visit ${requestedItem.url}`);
         }
-        logNoCommand(argumentName);
-        return;
-    }
-    const requestedItem = requestableItems.get(options.arguments[0]);
-    if (requestedItem != null) {
-        console.log(`Opening the ${requestedItem.name}`);
-        moduleFunctionWrapper_js_1.moduleFunctionWrapper.open(requestedItem.url, (err) => {
-            if (err != null) {
-                console.log(`Failed to open browser, please visit ${requestedItem.url}`);
-            }
-        });
-        return;
-    }
-    logNoCommand(options.arguments[0]);
+    });
 }
 exports.default = browseHandler;

package/src/commands/browse.spec.js

@@ -5,77 +5,44 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 // import * as open from 'open'
 const globals_1 = require("@jest/globals");
-const moduleFunctionWrapper_js_1 = require("../util/moduleFunctionWrapper.js");
-const browse_js_1 = __importDefault(require("./browse.js"));
-const commandsText = `Commands:
-    pay browse concourse       # browses the concourse page
-    pay browse help [COMMAND]  # Describe subcommands or one specific subcommand
-    pay browse manual          # browses the pay team manual
-    pay browse repo            # browses the pay-infra github repo
-    pay browse status          # browses the pay status page`;
+const moduleFunctionWrapper_1 = require("../util/moduleFunctionWrapper");
+const browse_1 = __importDefault(require("./browse"));
 (0, globals_1.describe)('browse command', () => {
     (0, globals_1.beforeEach)(() => {
         globals_1.jest.spyOn(console, 'log').mockImplementation(() => { });
         globals_1.jest.spyOn(console, 'error').mockImplementation(() => { });
-        globals_1.jest.spyOn(moduleFunctionWrapper_js_1.moduleFunctionWrapper, 'open').mockImplementation(() => { });
+        globals_1.jest.spyOn(moduleFunctionWrapper_1.moduleFunctionWrapper, 'open').mockImplementation(() => { });
     });
     (0, globals_1.afterEach)(() => {
         globals_1.jest.restoreAllMocks();
         globals_1.jest.resetModules();
     });
-    (0, globals_1.it)('should show usage when no additional params are provided', async () => {
-        await (0, browse_js_1.default)({ commandName: 'browse', arguments: [] });
-        (0, globals_1.expect)(console.log).toHaveBeenCalledWith(commandsText);
-    });
     (0, globals_1.it)('should open the browser when manual is provided as the first param', async () => {
-        await (0, browse_js_1.default)({ commandName: 'browse', arguments: ['manual'] });
-        (0, globals_1.expect)(moduleFunctionWrapper_js_1.moduleFunctionWrapper.open).toHaveBeenCalledWith('https://manual.payments.service.gov.uk/', globals_1.expect.any(Function));
+        const argv = { _: ['browse'], $0: 'pay', location: 'manual' };
+        await (0, browse_1.default)(argv);
+        (0, globals_1.expect)(moduleFunctionWrapper_1.moduleFunctionWrapper.open).toHaveBeenCalledWith('https://manual.payments.service.gov.uk/', globals_1.expect.any(Function));
         (0, globals_1.expect)(console.log).toHaveBeenCalledWith('Opening the team manual');
         (0, globals_1.expect)(console.error).not.toHaveBeenCalled();
     });
     (0, globals_1.it)('should open the browser when concourse is provided as the first param', async () => {
-        await (0, browse_js_1.default)({ commandName: 'browse', arguments: ['concourse'] });
-        (0, globals_1.expect)(moduleFunctionWrapper_js_1.moduleFunctionWrapper.open).toHaveBeenCalledWith('https://pay-cd.deploy.payments.service.gov.uk/', globals_1.expect.any(Function));
+        const argv = { _: ['browse'], $0: 'pay', location: 'concourse' };
+        await (0, browse_1.default)(argv);
+        (0, globals_1.expect)(moduleFunctionWrapper_1.moduleFunctionWrapper.open).toHaveBeenCalledWith('https://pay-cd.deploy.payments.service.gov.uk/', globals_1.expect.any(Function));
         (0, globals_1.expect)(console.log).toHaveBeenCalledWith('Opening the concourse page');
         (0, globals_1.expect)(console.error).not.toHaveBeenCalled();
     });
     (0, globals_1.it)('should open the browser when repo is provided as the first param', async () => {
-        await (0, browse_js_1.default)({ commandName: 'browse', arguments: ['repo'] });
-        (0, globals_1.expect)(moduleFunctionWrapper_js_1.moduleFunctionWrapper.open).toHaveBeenCalledWith('https://github.com/alphagov/pay-infra', globals_1.expect.any(Function));
+        const argv = { _: ['browse'], $0: 'pay', location: 'repo' };
+        await (0, browse_1.default)(argv);
+        (0, globals_1.expect)(moduleFunctionWrapper_1.moduleFunctionWrapper.open).toHaveBeenCalledWith('https://github.com/alphagov/pay-infra', globals_1.expect.any(Function));
         (0, globals_1.expect)(console.log).toHaveBeenCalledWith('Opening the pay-infra github repository');
         (0, globals_1.expect)(console.error).not.toHaveBeenCalled();
     });
     (0, globals_1.it)('should open the browser when status is provided as the first param', async () => {
-        await (0, browse_js_1.default)({ commandName: 'browse', arguments: ['status'] });
-        (0, globals_1.expect)(moduleFunctionWrapper_js_1.moduleFunctionWrapper.open).toHaveBeenCalledWith('https://payments.statuspage.io/', globals_1.expect.any(Function));
+        const argv = { _: ['browse'], $0: 'pay', location: 'status' };
+        await (0, browse_1.default)(argv);
+        (0, globals_1.expect)(moduleFunctionWrapper_1.moduleFunctionWrapper.open).toHaveBeenCalledWith('https://payments.statuspage.io/', globals_1.expect.any(Function));
         (0, globals_1.expect)(console.log).toHaveBeenCalledWith('Opening the status page');
         (0, globals_1.expect)(console.error).not.toHaveBeenCalled();
     });
-    (0, globals_1.it)('should show the help page when requested', async () => {
-        await (0, browse_js_1.default)({ commandName: 'browse', arguments: ['help'] });
-        (0, globals_1.expect)(moduleFunctionWrapper_js_1.moduleFunctionWrapper.open).not.toHaveBeenCalled();
-        (0, globals_1.expect)(console.log).toHaveBeenCalledWith(`Commands:
-    pay browse concourse       # browses the concourse page
-    pay browse help [COMMAND]  # Describe subcommands or one specific subcommand
-    pay browse manual          # browses the pay team manual
-    pay browse repo            # browses the pay-infra github repo
-    pay browse status          # browses the pay status page`);
-    });
-    (0, globals_1.it)('should details about a command', async () => {
-        await (0, browse_js_1.default)({ commandName: 'browse', arguments: ['help', 'manual'] });
-        (0, globals_1.expect)(moduleFunctionWrapper_js_1.moduleFunctionWrapper.open).not.toHaveBeenCalled();
-        (0, globals_1.expect)(console.log).toHaveBeenCalledWith('Usage:');
-        (0, globals_1.expect)(console.log).toHaveBeenCalledWith('browses the team manual');
-    });
-    (0, globals_1.it)('should handle an unknown command', async () => {
-        await (0, browse_js_1.default)({ commandName: 'browse', arguments: ['abcdef'] });
-        (0, globals_1.expect)(moduleFunctionWrapper_js_1.moduleFunctionWrapper.open).not.toHaveBeenCalled();
-        (0, globals_1.expect)(console.error).toHaveBeenCalledWith('Could not find command "abcdef".');
-        (0, globals_1.expect)(console.log).toHaveBeenCalledWith('The available options are: "concourse", "manual", "repo", "status".');
-    });
-    (0, globals_1.it)('should handle an unknown command within help', async () => {
-        await (0, browse_js_1.default)({ commandName: 'browse', arguments: ['help', 'abcdef'] });
-        (0, globals_1.expect)(moduleFunctionWrapper_js_1.moduleFunctionWrapper.open).not.toHaveBeenCalled();
-        (0, globals_1.expect)(console.error).toHaveBeenCalledWith('Could not find command "abcdef".');
-    });
 });

package/src/commands/demo.js

@@ -1,6 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-async function demoHandler(options) {
+exports.handler = exports.builder = exports.desc = exports.command = void 0;
+const standardContent_1 = require("../core/standardContent");
+exports.command = 'demo';
+exports.desc = false; // Hide command from generated help
+exports.builder = {};
+exports.handler = demoHandler;
+async function demoHandler(argv) {
+    await (0, standardContent_1.showHeader)();
     console.log('This is where you would put your implementation.');
     await new Promise((resolve) => {
         setTimeout(resolve, 10);
@@ -8,4 +15,3 @@ async function demoHandler(options) {
     console.log('It can be asynchronous.');
     console.error('You can also write to stderr.');
 }
-exports.default = demoHandler;

package/src/commands/legacy.js

@@ -23,25 +23,25 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.proxyHandlerOptionsToLegacyCli = exports.proxyArrayOfArgumentsToLegacyCli = void 0;
+exports.proxyArrayOfArgumentsToLegacyCli = exports.handler = exports.builder = exports.desc = exports.command = void 0;
 const payCliExec_1 = __importStar(require("../util/payCliExec"));
 const path = __importStar(require("node:path"));
 const constants_1 = require("../core/constants");
-const standardContent_1 = require("../core/standardContent");
 const pathToLegacyRubyCli = path.join(constants_1.rootDir, 'resources', 'legacy-ruby-cli');
-async function legacyHandler(options) {
-    const argsToPassOn = [];
-    if (options.commandName !== 'legacy') {
-        argsToPassOn.unshift(options.commandName);
-    }
-    options.arguments.forEach((arg) => {
-        argsToPassOn.push(arg);
-    });
+exports.command = 'legacy';
+exports.desc = 'Pass through to legacy ruby cli';
+const commandDesc = '$0 legacy -- {ruby version command and options}';
+const longDesc = 'Use the legacy ruby version of the pay cli, passing through commands, options etc. The legacy command itself should be followed by `--` then the command from the ruby version followed by it\'s parameters and options. e.g. use `pay legacy -- help` to run help on the legacy version.';
+const builder = (yargs) => {
+    return yargs.usage(`${commandDesc}\n\n${longDesc}`);
+};
+exports.builder = builder;
+exports.handler = legacyHandler;
+async function legacyHandler(argv) {
+    const argsToPassOn = argv._.slice(1);
     await proxyArrayOfArgumentsToLegacyCli(argsToPassOn);
 }
-exports.default = legacyHandler;
 async function proxyArrayOfArgumentsToLegacyCli(argsToPassOn) {
-    await (0, standardContent_1.showHeader)();
     const rbenvCommand = process.env.PAY_CLI_RBENV_COMMAND ?? 'rbenv';
     const shellCommand = process.env.PAY_CLI_SHELL_COMMAND ?? 'zsh';
     const whichRbenvResult = await (0, payCliExec_1.execAndReturnIO)(`which ${rbenvCommand}`);
@@ -67,7 +67,3 @@ async function proxyArrayOfArgumentsToLegacyCli(argsToPassOn) {
     });
 }
 exports.proxyArrayOfArgumentsToLegacyCli = proxyArrayOfArgumentsToLegacyCli;
-async function proxyHandlerOptionsToLegacyCli(options) {
-    await proxyArrayOfArgumentsToLegacyCli([options.commandName].concat(options.arguments));
-}
-exports.proxyHandlerOptionsToLegacyCli = proxyHandlerOptionsToLegacyCli;

package/src/commands/local/app_client/app_client.js

@@ -0,0 +1,232 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_crypto_1 = __importDefault(require("node:crypto"));
+const fetch_wrapper_1 = require("./fetch_wrapper");
+const pay_local_cluster_js_1 = require("../config/pay_local_cluster.js");
+let SERVICES_CONFIG;
+const appClient = {
+    async createPaymentLink(apiKey) {
+        const paymentLinkData = {
+            pay_api_token: apiKey,
+            name: 'exampleName',
+            price: 100,
+            gateway_account_id: '1',
+            return_url: 'https://test.test/some_reference',
+            service_name: 'aServiceName',
+            type: 'ADHOC',
+            service_name_path: 'aServiceNamePath',
+            product_name_path: node_crypto_1.default.randomBytes(16).toString('hex'),
+            reference_enabled: false
+        };
+        const url = urlFor('products', '/v1/api/products/');
+        const result = await (0, fetch_wrapper_1.postRequest)(url, paymentLinkData);
+        if (!result.success) {
+            console.error((0, fetch_wrapper_1.formatErrorMessageForFailedRequest)(result.unsuccessfulResult));
+            return;
+        }
+        const body = result.successfulResult?.body;
+        if (body === undefined || typeof body === 'string') {
+            console.error('The response to a request payment links did not have a body, or the body was not JSON!');
+            return;
+        }
+        if (!Object.hasOwn(body, '_links')) {
+            console.error('The response to create a payment link did not include an _links property');
+            return;
+        }
+        const typedBody = body;
+        return typedBody._links;
+    },
+    async createService() {
+        const createServiceData = {
+            en: 'My service',
+            cy: 'Welsh name for My service'
+        };
+        const url = urlFor('adminusers', '/v1/api/services');
+        const result = await (0, fetch_wrapper_1.postRequest)(url, createServiceData);
+        if (!result.success) {
+            console.error((0, fetch_wrapper_1.formatErrorMessageForFailedRequest)(result.unsuccessfulResult));
+            return;
+        }
+        const body = result.successfulResult?.body;
+        if (body === undefined || typeof body === 'string') {
+            console.error('The response to a create a service did not have a body, or the body was not JSON!');
+            return;
+        }
+        if (!Object.hasOwn(body, 'external_id')) {
+            console.error('The response to create a service did not include an external_id property');
+            return;
+        }
+        const typedBody = body;
+        return typedBody.external_id;
+    },
+    async createAccountInServiceWithEmailCollectionMode(serviceExternalID, emailCollectionMode) {
+        const account = await appClient.createAccount(serviceExternalID);
+        if (account === undefined) {
+            console.error('Failed to create account');
+            return;
+        }
+        if (!await appClient.setEmailCollectionModeOnAccount(account.gateway_account_id, emailCollectionMode)) {
+            console.error('Failed to set email collection mode on gateway account');
+            return;
+        }
+        if (!await appClient.addGatewayAccountToService(account.gateway_account_id, serviceExternalID)) {
+            console.error('Failed to add the gateway account to the service');
+            return;
+        }
+        return account;
+    },
+    async createAccount(serviceID) {
+        const createAccountData = {
+            payment_provider: 'sandbox',
+            service_name: 'My service',
+            type: 'test',
+            service_id: serviceID
+        };
+        const url = urlFor('connector', '/v1/api/accounts');
+        const result = await (0, fetch_wrapper_1.postRequest)(url, createAccountData);
+        if (!result.success) {
+            console.error((0, fetch_wrapper_1.formatErrorMessageForFailedRequest)(result.unsuccessfulResult));
+            return;
+        }
+        const body = result.successfulResult?.body;
+        if (body === undefined || typeof body === 'string') {
+            console.error('The response to a create an account did not have a body, or the body was not JSON!');
+            return;
+        }
+        const typedBody = body;
+        return typedBody;
+    },
+    async setEmailCollectionModeOnAccount(accountID, emailCollectionMode) {
+        const patchEmailCollectionModeData = {
+            op: 'replace',
+            path: 'email_collection_mode',
+            value: emailCollectionMode
+        };
+        const url = urlFor('connector', `/v1/api/accounts/${accountID}`);
+        const result = await (0, fetch_wrapper_1.patchRequest)(url, patchEmailCollectionModeData);
+        if (!result.success) {
+            console.error((0, fetch_wrapper_1.formatErrorMessageForFailedRequest)(result.unsuccessfulResult));
+            return false;
+        }
+        return true;
+    },
+    async addGatewayAccountToService(accountID, serviceID) {
+        const patchAddGatewayAccountToServiceData = {
+            op: 'add',
+            path: 'gateway_account_ids',
+            value: [accountID]
+        };
+        const url = urlFor('adminusers', `/v1/api/services/${serviceID}`);
+        const result = await (0, fetch_wrapper_1.patchRequest)(url, patchAddGatewayAccountToServiceData);
+        if (!result.success) {
+            console.error((0, fetch_wrapper_1.formatErrorMessageForFailedRequest)(result.unsuccessfulResult));
+            return false;
+        }
+        return true;
+    },
+    async createToken(gatewayAccountID) {
+        const createTokenData = {
+            account_id: gatewayAccountID,
+            description: 'my token',
+            created_by: 'system generated',
+            token_type: 'CARD'
+        };
+        const url = urlFor('publicauth', '/v1/frontend/auth');
+        const result = await (0, fetch_wrapper_1.postRequest)(url, createTokenData);
+        if (!result.success) {
+            console.error((0, fetch_wrapper_1.formatErrorMessageForFailedRequest)(result.unsuccessfulResult));
+            return;
+        }
+        const body = result.successfulResult?.body;
+        if (body === undefined || typeof body === 'string') {
+            console.error('The response to a create a token did not have a body, or the body was not JSON!');
+            return;
+        }
+        const typedBody = body;
+        return typedBody.token;
+    },
+    async createPayment(apiToken) {
+        const createPaymentData = {
+            amount: 1000,
+            description: 'my payment',
+            reference: 'my payment reference',
+            return_url: new URL('https://www.payments.service.gov.uk')
+        };
+        const url = urlFor('publicapi', '/v1/payments');
+        const result = await (0, fetch_wrapper_1.postRequest)(url, createPaymentData, apiToken);
+        if (!result.success) {
+            console.error((0, fetch_wrapper_1.formatErrorMessageForFailedRequest)(result.unsuccessfulResult));
+            return;
+        }
+        const body = result.successfulResult?.body;
+        if (body === undefined || typeof body === 'string') {
+            console.error('The response to a create a payment did not have a body, or the body was not JSON!');
+            return;
+        }
+        return body;
+    },
+    async createUser(gatewayAccountIDs, roleName) {
+        const createUserData = {
+            gateway_account_ids: gatewayAccountIDs,
+            email: `${node_crypto_1.default.randomBytes(16).toString('hex')}@example.com`,
+            password: `${node_crypto_1.default.randomBytes(10).toString('hex')}`,
+            telephone_number: '01134960000',
+            role_name: roleName
+        };
+        const url = urlFor('adminusers', '/v1/api/users');
+        const result = await (0, fetch_wrapper_1.postRequest)(url, createUserData);
+        if (!result.success) {
+            console.error((0, fetch_wrapper_1.formatErrorMessageForFailedRequest)(result.unsuccessfulResult));
+            return;
+        }
+        const body = result.successfulResult?.body;
+        if (body === undefined || typeof body === 'string') {
+            console.error('The response to a create a user did not have a body, or the body was not JSON!');
+            return;
+        }
+        const typedAugmentedBody = {
+            ...createUserData,
+            ...body
+        };
+        return typedAugmentedBody;
+    },
+    async isHealthy(serviceName) {
+        const url = urlFor(serviceName, '/healthcheck');
+        const response = await (0, fetch_wrapper_1.getRequest)(url);
+        return response.success;
+    },
+    async isUnhealthy(serviceName) {
+        return !await this.isHealthy(serviceName);
+    },
+    async isProxyHealthy(serviceName) {
+        const proxyUrl = this.externalUrlFor(serviceName, '/healthcheck', true);
+        const response = await (0, fetch_wrapper_1.getRequest)(proxyUrl);
+        return response.success;
+    },
+    externalUrlFor(serviceName, resource, proxy) {
+        if (SERVICES_CONFIG === undefined) {
+            SERVICES_CONFIG = (0, pay_local_cluster_js_1.loadServicesConfig)();
+        }
+        if (!(serviceName in SERVICES_CONFIG)) {
+            throw new Error(`Tried to look up service config for ${serviceName} but it isn't defined in the service_config.yaml file`);
+        }
+        const proxyPort = SERVICES_CONFIG[serviceName].proxy_port;
+        if (proxy && proxyPort !== undefined) {
+            return `https://127.0.0.1:${proxyPort}${resource}`;
+        }
+        return `http://127.0.0.1:${SERVICES_CONFIG[serviceName].port}${resource}`;
+    }
+};
+function urlFor(serviceName, resource) {
+    if (SERVICES_CONFIG === undefined) {
+        SERVICES_CONFIG = (0, pay_local_cluster_js_1.loadServicesConfig)();
+    }
+    if (!(serviceName in SERVICES_CONFIG)) {
+        throw new Error(`Tried to look up service config for ${serviceName} but it isn't defined in the service_config.yaml file`);
+    }
+    return appClient.externalUrlFor(serviceName, resource, false);
+}
+exports.default = appClient;

package/src/commands/local/app_client/fetch_wrapper.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatErrorMessageForFailedRequest = exports.patchRequest = exports.postRequest = exports.getRequest = void 0;
+async function getRequest(url, authToken) {
+    return await makeRequest(url, { headers: defaultHeaders(authToken) });
+}
+exports.getRequest = getRequest;
+async function postRequest(url, body, authToken) {
+    return await makeRequest(url, {
+        method: 'POST',
+        body: JSON.stringify(body),
+        headers: defaultHeaders(authToken)
+    });
+}
+exports.postRequest = postRequest;
+async function patchRequest(url, body, authToken) {
+    return await makeRequest(url, {
+        method: 'PATCH',
+        body: JSON.stringify(body),
+        headers: defaultHeaders(authToken)
+    });
+}
+exports.patchRequest = patchRequest;
+function formatErrorMessageForFailedRequest(unsuccessfulResult) {
+    if (unsuccessfulResult === undefined) {
+        return 'The result was successful';
+    }
+    let errorMessage = '';
+    if (unsuccessfulResult.error !== null && unsuccessfulResult.error !== undefined) {
+        errorMessage = unsuccessfulResult.error.message;
+    }
+    if (unsuccessfulResult.response === undefined) {
+        return `No response was received from the server, the following error was thrown:\n${errorMessage}`;
+    }
+    else {
+        if (unsuccessfulResult.error === undefined) {
+            return 'The server returned a non-ok HTTP response, no other error was thrown\n' +
+                `Response Code: ${unsuccessfulResult.response?.status}\n` +
+                `Response Text: ${unsuccessfulResult.response?.statusText}`;
+        }
+        else {
+            return 'A response was recevied from the server, but an error was also thrown.\n' +
+                `Error: ${errorMessage}` +
+                `Response Code: ${unsuccessfulResult?.response?.status}\n` +
+                `Response Text: ${unsuccessfulResult?.response?.statusText}`;
+        }
+    }
+}
+exports.formatErrorMessageForFailedRequest = formatErrorMessageForFailedRequest;
+/**
+ * The error handling around requests is absymal, so we'll catch all possible errors and return a result with a
+ * concrete type which is easier for clients to understand and deal with, containing the complexity to only this
+ * function
+ */
+async function makeRequest(url, requestOptions) {
+    let response;
+    try {
+        response = await fetch(url, requestOptions);
+        if (!response.ok) {
+            return {
+                success: false,
+                unsuccessfulResult: {
+                    response
+                }
+            };
+        }
+    }
+    catch (error) {
+        return {
+            success: false,
+            unsuccessfulResult: {
+                error
+            }
+        };
+    }
+    try {
+        const rawBody = await response.text();
+        const jsonResponse = response.headers.get('Content-Type') === 'application/json';
+        return {
+            success: true,
+            successfulResult: {
+                response,
+                body: jsonResponse ? await JSON.parse(rawBody) : rawBody
+            }
+        };
+    }
+    catch (error) {
+        return {
+            success: false,
+            unsuccessfulResult: {
+                response,
+                error
+            }
+        };
+    }
+}
+function defaultHeaders(authToken) {
+    const headers = new Headers({
+        'Content-Type': 'application/json',
+        Accept: 'application/json'
+    });
+    if (authToken !== undefined) {
+        headers.set('Authorization', `Bearer ${authToken}`);
+    }
+    return headers;
+}