Connections Summary
-
@@ -88,6 +101,7 @@ export default class ConnectionTemplates {
disabled={true}
name="some action"
showIcon={true}
+ fillButton={true}
/>
diff --git a/src/views/newConnection.tsx b/src/views/newConnection.tsx
deleted file mode 100644
index 736819c8..00000000
--- a/src/views/newConnection.tsx
+++ /dev/null
@@ -1,201 +0,0 @@
-import Html from '@kitajs/html'
-import { singleton } from 'tsyringe'
-import { CompanyProfile } from '../models/companyHouseEntity.js'
-import { COMPANY_NUMBER, EMAIL, companyNumberRegex } from '../models/strings.js'
-import { ButtonIcon, FormButton, Page } from './common.js'
-
-export type CompanyProfileText =
- | {
- status: 'success'
- company: CompanyProfile
- }
- | {
- status: 'error'
- errorMessage: string
- }
-
-export type FormStage = 'form' | 'confirmation' | 'success'
-
-@singleton()
-export default class newConnectionTemplates {
- constructor() {}
-
- public formPage = (targetBox: CompanyProfileText, formStage: FormStage) => {
- return (
-
-
- )
- }
-
- public companyFormInput = (params: {
- targetBox: CompanyProfileText
- formStage: FormStage
- email?: EMAIL
- companyNumber?: COMPANY_NUMBER
- }): JSX.Element => {
- const showForm = params.formStage === 'form' ? true : false
- const showConfirmation = params.formStage === 'confirmation' ? true : false
- const showSuccess = params.formStage === 'success' ? true : false
- return (
- <>
-
-
- )
- }
-
- public companyFilledTextBox = ({ company }: { company: CompanyProfile }): JSX.Element => {
- return (
- <>
- Registered Office Address
-
- Veritable - New Connection "`;
+
+exports[`NewInviteTemplates show form should render a web page with the a form in an empty state 2`] = `"Veritable - New Connection "`;
+
+exports[`NewInviteTemplates show form should render a web page with the a form in an error state 1`] = `"Veritable - New Connection "`;
+
+exports[`NewInviteTemplates show form should render form with a error message and invalid response 1`] = `""`;
+
+exports[`NewInviteTemplates show form should render form with a valid response 1`] = `""`;
diff --git a/src/views/newConnection/__tests__/newInvite.test.ts b/src/views/newConnection/__tests__/newInvite.test.ts
new file mode 100644
index 00000000..a36788d8
--- /dev/null
+++ b/src/views/newConnection/__tests__/newInvite.test.ts
@@ -0,0 +1,50 @@
+import { expect } from 'chai'
+import { describe, it } from 'mocha'
+
+import { NewInviteTemplates } from '../newInvite.js'
+import { successResponse, testErrorTargetBox, testMessageTargetBox, testSuccessTargetBox } from './fixtures.js'
+
+describe('NewInviteTemplates', () => {
+ describe('show form', () => {
+ it('should render form with a error message and invalid response', async () => {
+ const templates = new NewInviteTemplates()
+ const rendered = await templates.newInviteForm({ feedback: testMessageTargetBox, formStage: 'form' })
+ expect(rendered).to.matchSnapshot()
+ })
+
+ it('should render form with a valid response', async () => {
+ const templates = new NewInviteTemplates()
+ const rendered = await templates.newInviteForm({ feedback: testSuccessTargetBox, formStage: 'form' })
+ expect(rendered).to.matchSnapshot()
+ })
+
+ it('should render a confirmation page with given email and company number', async () => {
+ const templates = new NewInviteTemplates()
+ const rendered = await templates.newInviteForm({
+ feedback: testSuccessTargetBox,
+ formStage: 'confirmation',
+ email: '123@123.com',
+ companyNumber: successResponse.company_number,
+ })
+ expect(rendered).to.matchSnapshot()
+ })
+
+ it('should render a success response page with a single button to return to home', async () => {
+ const templates = new NewInviteTemplates()
+ const rendered = await templates.newInviteForm({ feedback: testSuccessTargetBox, formStage: 'success' })
+ expect(rendered).to.matchSnapshot()
+ })
+
+ it('should a web page with the a form in an empty state', async () => {
+ const templates = new NewInviteTemplates()
+ const rendered = await templates.newInviteFormPage(testMessageTargetBox)
+ expect(rendered).to.matchSnapshot()
+ })
+
+ it('should a web page with the a form in an error state', async () => {
+ const templates = new NewInviteTemplates()
+ const rendered = await templates.newInviteFormPage(testErrorTargetBox)
+ expect(rendered).to.matchSnapshot()
+ })
+ })
+})
diff --git a/src/views/newConnection/__tests__/newInvite.test.ts.snap b/src/views/newConnection/__tests__/newInvite.test.ts.snap
new file mode 100644
index 00000000..f5ba40cb
--- /dev/null
+++ b/src/views/newConnection/__tests__/newInvite.test.ts.snap
@@ -0,0 +1,23 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`NewInviteTemplates show form should a web page with the a form in an empty state 1`] = `"Veritable - New Connection "`;
+
+exports[`NewInviteTemplates show form should a web page with the a form in an error state 1`] = `"Veritable - New Connection "`;
+
+exports[`NewInviteTemplates show form should render Error message with text error test 1`] = `""`;
+
+exports[`NewInviteTemplates show form should render a stepper html at stage 2 1`] = `""`;
+
+exports[`NewInviteTemplates show form should render a stepper html at stage 3 1`] = `""`;
+
+exports[`NewInviteTemplates show form should render a success response page with a single button to return to home 1`] = `""`;
+
+exports[`NewInviteTemplates show form should render a valid company in filled company test box 1`] = `"![\\"Description](\\"/public/images/check.svg\\")
"`;
+
+exports[`NewInviteTemplates show form should render form with a error message and invalid response 1`] = `""`;
+
+exports[`NewInviteTemplates show form should render form with a valid response 1`] = `""`;
diff --git a/src/views/newConnection/base.tsx b/src/views/newConnection/base.tsx
new file mode 100644
index 00000000..a5f8ea19
--- /dev/null
+++ b/src/views/newConnection/base.tsx
@@ -0,0 +1,139 @@
+import Html from '@kitajs/html'
+import { CompanyProfile } from '../../models/companyHouseEntity.js'
+import { ButtonIcon, FormButton } from '../common.js'
+
+export type FormFeedback =
+ | {
+ type: 'companyFound'
+ company: CompanyProfile
+ }
+ | {
+ type: 'message'
+ message: string
+ }
+ | {
+ type: 'error'
+ error: string
+ }
+
+export type FormAction =
+ | {
+ type: 'submit'
+ value: string
+ text: string
+ }
+ | {
+ type: 'link'
+ text: string
+ href: string
+ }
+
+export abstract class NewConnectionTemplates {
+ protected newConnectionForm = (
+ props: Html.PropsWithChildren<{
+ submitRoute: 'create-invitation' | 'receive-invitation'
+ feedback: FormFeedback
+ progressStep: number
+ progressStepCount: number
+ actions: FormAction[]
+ }>
+ ): JSX.Element => {
+ return (
+
+ )
+ }
+
+ protected feedback = (props: { feedback: FormFeedback }): JSX.Element => {
+ switch (props.feedback.type) {
+ case 'message':
+ return
+
+ )
+ }
+
+ public fromInviteForm = (props: { formStage: FromInviteFormStage; feedback: FormFeedback }): JSX.Element => {
+ switch (props.formStage) {
+ case 'invite':
+ return
+
+ )
+ }
+
+ private fromInviteSuccess = (props: { feedback: FormFeedback }): JSX.Element => {
+ return (
+
+
+ )
+ }
+}
diff --git a/src/views/newConnection/newInvite.tsx b/src/views/newConnection/newInvite.tsx
new file mode 100644
index 00000000..43138323
--- /dev/null
+++ b/src/views/newConnection/newInvite.tsx
@@ -0,0 +1,158 @@
+import Html from '@kitajs/html'
+import { singleton } from 'tsyringe'
+import { COMPANY_NUMBER, EMAIL, companyNumberRegex } from '../../models/strings.js'
+import { Page } from '../common.js'
+import { FormFeedback, NewConnectionTemplates } from './base.js'
+
+export type NewInviteFormStage = 'form' | 'confirmation' | 'success'
+
+@singleton()
+export class NewInviteTemplates extends NewConnectionTemplates {
+ constructor() {
+ super()
+ }
+
+ public newInviteFormPage = (feedback: FormFeedback) => {
+ return (
+
+
+ )
+ }
+
+ public newInviteForm = (props: {
+ formStage: NewInviteFormStage
+ companyNumber?: COMPANY_NUMBER
+ email?: EMAIL
+ feedback: FormFeedback
+ }): JSX.Element => {
+ switch (props.formStage) {
+ case 'form':
+ return
+
+
+
+ )
+ }
+
+ private newInviteConfirmation = (props: {
+ companyNumber?: COMPANY_NUMBER
+ email?: EMAIL
+ feedback: FormFeedback
+ }): JSX.Element => {
+ return (
+
+
+
+
+ )
+ }
+
+ private newInviteSuccess = (props: { feedback: FormFeedback }): JSX.Element => {
+ return (
+
+
+ )
+ }
+}
diff --git a/test/helpers/cloudagent.ts b/test/helpers/cloudagent.ts
new file mode 100644
index 00000000..9d2d0753
--- /dev/null
+++ b/test/helpers/cloudagent.ts
@@ -0,0 +1,26 @@
+import { Env } from '../../src/env.js'
+import VeritableCloudagent from '../../src/models/veritableCloudagent.js'
+
+import { validCompanyName, validCompanyNumber } from './fixtures.js'
+
+export function withBobCloudAgentInvite(context: { invite: string }) {
+ let agent = new VeritableCloudagent({
+ get(name) {
+ if (name === 'CLOUDAGENT_ADMIN_ORIGIN') {
+ return 'http://localhost:3101'
+ }
+ throw new Error('Unexpected env variable request')
+ },
+ } as Env)
+
+ beforeEach(async function () {
+ const invite = await agent.createOutOfBandInvite({ companyName: validCompanyName })
+ context.invite = Buffer.from(
+ JSON.stringify({
+ companyNumber: validCompanyNumber,
+ inviteUrl: invite.invitationUrl,
+ }),
+ 'utf8'
+ ).toString('base64url')
+ })
+}
diff --git a/test/helpers/fixtures.ts b/test/helpers/fixtures.ts
index 5a445dca..9bd466dc 100644
--- a/test/helpers/fixtures.ts
+++ b/test/helpers/fixtures.ts
@@ -1,9 +1,7 @@
import { CompanyProfile } from '../../src/models/companyHouseEntity.js'
-import { CompanyProfileText } from '../../src/views/newConnection.js'
export const validCompanyNumber = '07964699'
-export const invalidCompanyNumber = '079646992'
-export const noCompanyNumber = ''
+export const validCompanyName = 'DIGITAL CATAPULT'
export const successResponse: CompanyProfile = {
registered_office_address: {
@@ -13,16 +11,6 @@ export const successResponse: CompanyProfile = {
},
company_status: 'active',
registered_office_is_in_dispute: false,
- company_name: 'DIGITAL CATAPULT',
- company_number: '07964699',
-}
-
-export const testErrorTargetBox: CompanyProfileText = {
- status: 'error',
- errorMessage: 'This is a test error message',
-}
-
-export const testSuccessTargetBox: CompanyProfileText = {
- status: 'success',
- company: successResponse,
+ company_name: validCompanyName,
+ company_number: validCompanyNumber,
}
diff --git a/test/integration/newConnection.test.ts b/test/integration/newConnection.test.ts
index 56ef31fd..613eeff3 100644
--- a/test/integration/newConnection.test.ts
+++ b/test/integration/newConnection.test.ts
@@ -1,11 +1,11 @@
import { expect } from 'chai'
import express from 'express'
import { describe, it } from 'mocha'
-import sinon from 'sinon'
import { container } from 'tsyringe'
import Database from '../../src/models/db/index.js'
import createHttpServer from '../../src/server.js'
+import { withBobCloudAgentInvite } from '../helpers/cloudagent.js'
import { withCompanyHouseMock } from '../helpers/companyHouse.js'
import { cleanup } from '../helpers/db.js'
import { validCompanyNumber } from '../helpers/fixtures.js'
@@ -18,20 +18,52 @@ describe('NewConnectionController', () => {
afterEach(async () => {
await cleanup()
- sinon.restore()
})
withCompanyHouseMock()
- describe('happy path', function () {
+ describe('create invitation (happy path)', function () {
let response: Awaited>
beforeEach(async () => {
await cleanup()
app = await createHttpServer()
- response = await post(app, '/connection/new/submit', {
+ response = await post(app, '/connection/new/create-invitation', {
companyNumber: validCompanyNumber,
email: 'alice@example.com',
- submitButton: 'Submit',
+ action: 'submit',
+ })
+ })
+
+ it('should return success', async () => {
+ expect(response.status).to.equal(200)
+ })
+
+ it('should insert new connection into db', async () => {
+ const connectionRows = await db.get('connection')
+ expect(connectionRows.length).to.equal(1)
+ expect(connectionRows[0]).to.deep.contain({
+ company_name: 'DIGITAL CATAPULT',
+ company_number: '07964699',
+ status: 'pending',
+ })
+
+ const invites = await db.get('connection_invite', { connection_id: connectionRows[0].id })
+ expect(invites.length).to.equal(1)
+ })
+ })
+
+ describe('receive invitation (happy path)', function () {
+ let response: Awaited>
+ const context: { invite: string } = { invite: '' }
+
+ withBobCloudAgentInvite(context)
+
+ beforeEach(async () => {
+ await cleanup()
+ app = await createHttpServer()
+ response = await post(app, '/connection/new/receive-invitation', {
+ invite: context.invite,
+ action: 'createConnection',
})
})
diff --git a/test/test.env b/test/test.env
index fe39cb16..8aeca259 100644
--- a/test/test.env
+++ b/test/test.env
@@ -1 +1 @@
-COMPANY_PROFILE_API_KEY=API_KEY
\ No newline at end of file
+COMPANY_PROFILE_API_KEY=API_KEY
- Invite New Connection
-
-
-
- {Html.escapeHtml(company.company_name)}
-{Html.escapeHtml(company.registered_office_address.address_line_1)}
- {company?.registered_office_address?.address_line_2 && ( -{Html.escapeHtml(company.registered_office_address.address_line_2)}
- )} - {company?.registered_office_address?.address_line_2 && ( -{Html.escapeHtml(company.registered_office_address.address_line_2)}
- )} - {company?.registered_office_address?.care_of && ( -{Html.escapeHtml(company.registered_office_address.care_of)}
- )} - {company?.registered_office_address?.locality && ( -{Html.escapeHtml(company.registered_office_address.locality)}
- )} - {company?.registered_office_address?.po_box && ( -{Html.escapeHtml(company.registered_office_address.po_box)}
- )} - {company?.registered_office_address?.postal_code && ( -{Html.escapeHtml(company.registered_office_address.postal_code)}
- )} - {company?.registered_office_address?.country && ( -{Html.escapeHtml(company.registered_office_address.country)}
- )} - {company?.registered_office_address?.premises && ( -{Html.escapeHtml(company.registered_office_address.premises)}
- )} - {company?.registered_office_address?.region && ( -{Html.escapeHtml(company.registered_office_address.region)}
- )} - - Registered Office Address - -{Html.escapeHtml(company.company_status)}
- - ) - } - - public companyEmptyTextBox = ({ errorMessage }: { errorMessage: string }): JSX.Element => { - return{Html.escapeHtml(errorMessage)}
- } - - public stepper = (params: { formStage: FormStage }): JSX.Element => { - if (params.formStage === 'form') { - return ( -
-
-
- )
- } else if (params.formStage === 'confirmation') {
- return (
- Step 1 of 3
-
-
-
- )
- } else if (params.formStage === 'success') {
- return (
- Step 2 of 3
-
-
-
- )
- } else {
- return Step 3 of 3
- Stage Undefined
- }
- }
-}
diff --git a/src/views/newConnection/__tests__/fixtures.ts b/src/views/newConnection/__tests__/fixtures.ts
new file mode 100644
index 00000000..5ee4a798
--- /dev/null
+++ b/src/views/newConnection/__tests__/fixtures.ts
@@ -0,0 +1,29 @@
+import { CompanyProfile } from '../../../models/companyHouseEntity.js'
+import { FormFeedback } from '../base.js'
+
+export const successResponse: CompanyProfile = {
+ registered_office_address: {
+ address_line_1: 'Level 9, 101 Euston Road',
+ postal_code: 'NW1 2RA',
+ locality: 'London',
+ },
+ company_status: 'active',
+ registered_office_is_in_dispute: false,
+ company_name: 'DIGITAL CATAPULT',
+ company_number: '07964699',
+}
+
+export const testErrorTargetBox: FormFeedback = {
+ type: 'error',
+ error: 'This is a test error message',
+}
+
+export const testMessageTargetBox: FormFeedback = {
+ type: 'message',
+ message: 'This is a message',
+}
+
+export const testSuccessTargetBox: FormFeedback = {
+ type: 'companyFound',
+ company: successResponse,
+}
diff --git a/src/views/newConnection/__tests__/fromInvite.test.ts b/src/views/newConnection/__tests__/fromInvite.test.ts
new file mode 100644
index 00000000..05254815
--- /dev/null
+++ b/src/views/newConnection/__tests__/fromInvite.test.ts
@@ -0,0 +1,39 @@
+import { expect } from 'chai'
+import { describe, it } from 'mocha'
+
+import { FromInviteTemplates } from '../fromInvite.js'
+import { testErrorTargetBox, testMessageTargetBox, testSuccessTargetBox } from './fixtures.js'
+
+describe('NewInviteTemplates', () => {
+ describe('show form', () => {
+ it('should render form with a error message and invalid response', async () => {
+ const templates = new FromInviteTemplates()
+ const rendered = await templates.fromInviteForm({ feedback: testMessageTargetBox, formStage: 'invite' })
+ expect(rendered).to.matchSnapshot()
+ })
+
+ it('should render form with a valid response', async () => {
+ const templates = new FromInviteTemplates()
+ const rendered = await templates.fromInviteForm({ feedback: testSuccessTargetBox, formStage: 'success' })
+ expect(rendered).to.matchSnapshot()
+ })
+
+ it('should render a web page with the a form in an empty state', async () => {
+ const templates = new FromInviteTemplates()
+ const rendered = await templates.fromInviteFormPage(testSuccessTargetBox)
+ expect(rendered).to.matchSnapshot()
+ })
+
+ it('should render a web page with the a form in an empty state', async () => {
+ const templates = new FromInviteTemplates()
+ const rendered = await templates.fromInviteFormPage(testMessageTargetBox)
+ expect(rendered).to.matchSnapshot()
+ })
+
+ it('should render a web page with the a form in an error state', async () => {
+ const templates = new FromInviteTemplates()
+ const rendered = await templates.fromInviteFormPage(testErrorTargetBox)
+ expect(rendered).to.matchSnapshot()
+ })
+ })
+})
diff --git a/src/views/newConnection/__tests__/fromInvite.test.ts.snap b/src/views/newConnection/__tests__/fromInvite.test.ts.snap
new file mode 100644
index 00000000..743632bb
--- /dev/null
+++ b/src/views/newConnection/__tests__/fromInvite.test.ts.snap
@@ -0,0 +1,11 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`NewInviteTemplates show form should render a web page with the a form in an empty state 1`] = `"New Connection
Invite New Connection
New Connection
Invite New Connection
New Connection
Invite New Connection
New Connection
Invite New Connection
New Connection
Invite New Connection
error test
"`; + +exports[`NewInviteTemplates show form should render a confirmation page with given email and company number 1`] = `""`; + +exports[`NewInviteTemplates show form should render a stepper html at stage 1 1`] = `"Step 1 of 3
Step 2 of 3
Step 3 of 3
Registered Office AddressDIGITAL CATAPULT, Level 9, 101 Euston Road, London, NW1 2RA
Company Statusactive
+
+ )
+ }
+
+ protected feedbackMessage = ({ message, isError }: { message: string; isError: boolean }): JSX.Element => {
+ const messageClass = isError ? 'feedback-negative' : 'feedback-neutral'
+ return (
+
+
+ + Registered Office Address + {addressLines.map((line, i) => ( + + {Html.escapeHtml(line) + (i === addressLines.length - 1 ? '' : ', ')} + + ))} +
+ ++ Company Status + {Html.escapeHtml(company.company_status)} +
+
+ 
+
+
+
+ {Html.escapeHtml(message)}
+
+ )
+ }
+
+ protected stepper = (params: { stage: number; total: number }): JSX.Element => {
+ return (
+
+
+ )
+ }
+}
diff --git a/src/views/newConnection/fromInvite.tsx b/src/views/newConnection/fromInvite.tsx
new file mode 100644
index 00000000..2d2232ae
--- /dev/null
+++ b/src/views/newConnection/fromInvite.tsx
@@ -0,0 +1,90 @@
+import Html from '@kitajs/html'
+import { singleton } from 'tsyringe'
+import { Page } from '../common.js'
+import { FormFeedback, NewConnectionTemplates } from './base.js'
+
+export type FromInviteFormStage = 'invite' | 'success'
+
+@singleton()
+export class FromInviteTemplates extends NewConnectionTemplates {
+ constructor() {
+ super()
+ }
+
+ public fromInviteFormPage = (feedback: FormFeedback) => {
+ return (
+
+ Step {params.stage}
+ of {params.total}
+
+
+
+ Invite New Connection
+
+
+
+
+
+
+
+
+ + Your connection has been established, but still needs to be verified. You should receive a verification + letter at your registered business with instructions on how to do this. A reciprocal verification request + has been sent in the post on your behalf to the address on the right to verify their identity +
+
+ Invite New Connection
+
+
+
+
+
+ Please confirm the details of the connection before sending
++ {Html.escapeHtml( + `Company House Number: ${props.feedback.type === 'companyFound' && props.feedback.company.company_number}` + )} +
+{Html.escapeHtml(`Email Address: ${props.feedback.type === 'companyFound' && props.email}`)}
+After clicking submit, a connection invitation will be sent to their email and postal address.
+
+
+ + Your connection invitation has been sent. Please wait for their verification. As the post may take 2-3 days + to arrive, please wait for their verification and keep updated by viewing the verification status. +
+