CCM-13135: adding README

Author: nhsd-angel-pastor

scripts/config/vale/styles/config/vocabularies/words/accept.txt

@@ -90,6 +90,7 @@ temp_dir
 Terraform
 toolchain
 Trufflehog
+uat
 updateReadme
 Uploader
 uuid

utils/client-management/README.md

@@ -0,0 +1,146 @@
+# client-management
+
+TypeScript Library / CLI utility for managing comms manager client configuration. These are currently stored in SSM Parameter Store.
+
+## Usage
+
+### CLI Usage
+
+From the repo root run:
+
+```bash
+cd utils/client-management
+npm run-script cli -- <command> [options]
+```
+
+### Library Usage
+
+Install the package as `@client-management`
+
+Instantiate an instance of the library as follows. The library should take an implementation of an `IParameterStore` to define how the library will interact with SSM (e.g. caching vs non-caching).
+
+```ts
+import { ClientManagement } from '@client-management';
+
+const cm = ClientManagement({ parameterStore: new ParameterStore() });
+```
+
+### Global Options
+
+#### CLI Options
+
+- `--environment` - The name of the environment to run the command on e.g. 'de-<shortcode>', 'uat', 'prod'. Required.
+- `--format` - print data in json or tabular format. Default is `table`.
+
+#### Library Options
+
+```ts
+const cm = ClientManagement({
+  parameterStore: new ParameterStore(),
+  configOverrides: { environment: 'de-miha12' },
+});
+```
+
+## Commands
+
+### Client Configuration Commands
+
+- [Put Client](#put-client)
+- [List Clients](#list-clients)
+- [Get Client](#get-client)
+- [Delete Client](#delete-client)
+
+#### Put Client
+
+Insert a new client or update an existing one. Omit the `--client-id` option to insert a new client. Include it to update an existing client. Note: the INT and PROD clientIds should be the same ID.
+
+##### Put Client Options
+
+- `--client-id` - the ID of the client to update. (defaults to uuid. Should typically be excluded unless overwriting an existing client)
+- `--name` - the display name of the client. Will throw an error if this name is already taken. (required)
+- `--mesh-mailbox-id` - the mesh mailbox id for this client.
+- `--sender-ods-code` - the ODS code associated with this client. (required if --allow-ods-override is not set)
+- `--allow-ods-override` - allow ODS code to be overridden on a per-request basis for this client. (boolean, required if --sender-ods-code is not set)
+- `--allow-alternative-contact-details` - allow PDS contact details to be overridden on a per-request basis for this client. (boolean)
+- `--unprefixed-name` - does not include the prefix for the name of the citizen in communications.
+- `--allow-anonymous-patient` - allow client to send to anonymous patients.
+- `--ignore-security-flag` - allow client to send to s-flag patients.
+- `--allow-rfr-override` - allow client to send to patients with a Reason for Removal.
+- `--allow-rfr-override-codes` - comma separated list of Reason for Removal codes to permit sending of messages to. (zero, one or more of DEA EMB SCT NIT TRA ORR AFL AFN CAN CGA DIS LDN OPA RDI RDR RFI RPR SDL SDN)
+- `--apim-id` - the APIM ID, this is optional.
+
+##### Put Client Examples
+
+```bash
+pnpm --filter @client-management cli put-client \
+  --name vaccs \
+  --mesh-mailbox-id X71803 \
+  --sender-ods-code X71803 \
+  --allow-ods-override \
+  --allow-alternative-contact-details \
+  --unprefixed-name \
+  --allow-anonymous-patient \
+  --ignore-security-flag \
+  --allow-rfr-override \
+  --allowRfrOverrideCodes ORR,SCT \
+  --environment de-cljo1 \
+  --apim-id 65d68dae-f056-4c17-be03-769fc3b42881
+```
+
+```ts
+const client = await cm.putClient({
+  name: 'vaccs',
+  meshMailboxId: 'X71803',
+});
+```
+
+#### List Clients
+
+Return a list of all existing clients
+
+##### List Clients Examples
+
+```bash
+pnpm --filter @client-management cli list-clients \
+  --environment de-cljo1
+```
+
+```ts
+const clients = await cm.listClients();
+```
+
+#### Get Client
+
+Return an individual client by clientId
+
+##### Get Client Examples
+
+```bash
+pnpm --filter @client-management cli get-client \
+  --client-id 38a8223e-f92c-490b-8955-3493bd3a08f9 \
+  --environment de-cljo1
+```
+
+```ts
+const client = await cm.getClient({
+  clientId: '38a8223e-f92c-490b-8955-3493bd3a08f9',
+});
+```
+
+#### Delete Client
+
+Delete an individual client by clientId. If provided, the delete-metadata flag will trigger deletion of all metadata items belonging to the client.
+
+##### Delete Client Examples
+
+```bash
+pnpm --filter @client-management cli delete-client \
+  --client-id 38a8223e-f92c-490b-8955-3493bd3a08f9 \
+  --environment de-cljo1
+```
+
+```ts
+const client = await cm.getClientByName({
+  clientId: '38a8223e-f92c-490b-8955-3493bd3a08f9',
+});
+```