reapit / foundations Goto Github PK

As above; should import the following and associated scripts into SMB GraphQL package:

• Styled Components project
• Elements
• Linting
• Unit Testing
• E2E testing with Cypress
• React Router
• Config manager and setting of env variables
• Removal of any unused packages (there are a lot in the current package.json)
• Any tidy up you can see from the original scaffold, unused code etc.

Summary: As we are now using Reapit Connect to handle the 'Forgotten Password' flow we no longer require the use for the code for the developers login on the marketplace.

Task: To clean up the forgotten password flow in the Marketplace for the Developer Portal

Summary: To ensure the server knows we are editing the last version of a resource, we will need to include a ETag header when making PATCH requests

Task:

• Include ETag header when performing a PATCH in the header: 'If-Match'

Notes:

• You can get an ETag from a singular resource GET in the ETag header. The ETag is also included in the model as attribtue '_eTag'
• Error description if not included: description: "Precondition failed: Update operations require that the target resources current ETag is included in the requests 'If-Match' header."

Summary of Request:

TEST

Expected Behaviour

TEST

Summary: Currently we are storing the images as URL's in the metadata. When available from the Backend team, we need to update the component in the following places.

Task: is to update the File Uploader component when available.

Locations:

• Primary ID
• Secondary ID
• Address History

Summary: To ensure the server knows we are editing the last version of a resource, we will need to include a ETag header when making PATCH requests

Task:

• Include ETag header when performing a PATCH in the header: 'If-Match'

Notes:

• You can get an ETag from a singular resource GET in the ETag header. The ETag is also included in the model as attribtue '_eTag'
• Error description if not included: description: "Precondition failed: Update operations require that the target resources current ETag is included in the requests 'If-Match' header."

Task: To research potential PEP search API's to incorporate within the AML app

Background

Elements UI library is being refactored to ensure better DX, UX and a more lightweight, flexible library with a more consistent API

Task

• Should be part of the input module ie Input.RadioSelect
• Migrate component in line with overall specification here: https://github.com/reapit/foundations/blob/master/packages/elements-next/src/index.mdx
• Special concern should be given to the Specification section above, consistency, reusability and lightweight are our driving principles
• Should be deployed to new Elements Next documentation app in Docz library.
• Both code, testing and documentation to be of the highest possible standard, no corners cut. This is the library we will be using internally for a long time.

Summary: Currently we are storing the images as URL's in the metadata. When available from the Backend team, we need to update the component in the following places.

Task: is to update the File Uploader component when available.

Locations:

• Submit App
• Edit App

Relates to ticket: #71

Summary: Create Apollo server side query to populate the 'Users' table on the SMB App

• Query Apollo service to get Negotiators by company id
• Should also support upload of offices by CSV
• Table should populate with correct data

Please see the following UI issues detected when viewing the Welcome Wizard in mobile view on the Developers Portal.

Location: https://dev.marketplace.reapit.com/developer/welcome

• When in mobile view the circle and line alignment are slightly off when you go past number 1. 1 is fine.

See number 1:

Number’s 2-5 selection circles are not central:

• See example of the alignment of the line filler after number 1:
  

• The numbered navigation is also not centred in the container (slightly to the right):
  

• Change the ‘Get Started’ location on both mobile view and browser. Move the ‘Get Started’ button next to ‘Prev’ on step 5. That way the scrolling is always consistent.

See mock up for web:

See mock up for mobile:

• When the user clicks 'Next' on step 1, the page remains on the next button (the bottom section of the text), it should automatically navigate the user back to the top of the page.

Task: To create the routes and icons for the nav bar for the SMB application

Component from elements: https://reapit.github.io/elements/?path=/story/menu--primary

Routes and images below:

Home Icon: FaHome
Route: \home

Offices Icon: FaBuilding
Route: \offices

Users Icon: IoIosPeople
Route: \users

Sources Icon: FaClipboardList
Route: \sources

Marketing Icon: MdWeb
Route: \marketing

Lettings Icon: MdLibraryBooks
Route: \lettings

Support Icon: MdLiveHelp
Route: \support

Install Agency Cloud Icon: FaDownload
Route: \install

Summary: See above, the offices entity should be made available in the Apollo GQL Schema.

Task: To write in Apollo Server package

• Query for all Offices
• Query for office by id
• Mutation for new Office
• Mutation for office by id

Relates to ticket: #63

Summary: Create Apollo server side query to populate the 'Offices' table on the SMB App

• Query Apollo service to get Offices by company id
• Should also support upload of offices by CSV
• Table should populate with correct data

Summary: To ensure the server knows we are editing the last version of a resource, we will need to include a ETag header when making PATCH requests

Task:

• Include ETag header when performing a PATCH in the header: 'If-Match'

Notes:

• You can get an ETag from a singular resource GET in the ETag header. The ETag is also included in the model as attribtue '_eTag'
• Error description if not included: description: "Precondition failed: Update operations require that the target resources current ETag is included in the requests 'If-Match' header."

Relates to ticket: #71

Summary: The ‘Negotiators’ entity should be made available in the Apollo GQL Schema.

Task: To write in Apollo Server package:

• Query for all Negotiators
• Query for Negotiators by id
• Mutation for new Negotiator
• Mutation for Negotiator by by id

Background

Elements UI library is being refactored to ensure better DX, UX and a more lightweight, flexible library with a more consistent API

Task

• Write a base spec and add to Readme.md file on Elements for v3 of lib
• Add to Gitbook, changes in Elements v2, roadmap for v3

The Life Time Legal repo should be a package within the main Foundations repo

Should preserve git history
Should archive old project
Should normalise dependencies and tooling (tests, linting etc) with base repo
Should have a very basic pipeline that publishes master to NPM (Currently Manual)

Given that I am a ‘Negotiator’ and I am logged into the SMB App, when I click ‘Users’ from the nav bar, I want to navigate to the users areas

Task: To create a ‘Users’ page from the ‘Users’ option in the nav bar (route \users )

Page should include:
Header: Users
Wording: TBC (use lorem ipsum)

See mock up:

Background

Elements UI library is being refactored to ensure better DX, UX and a more lightweight, flexible library with a more consistent API

Task

• Should be part of the input module ie Input.TextArea
• Migrate component in line with overall specification here: https://github.com/reapit/foundations/blob/master/packages/elements-next/src/index.mdx
• Special concern should be given to the Specification section above, consistency, reusability and lightweight are our driving principles
• Should be deployed to new Elements Next documentation app in Docz library.
• Both code, testing and documentation to be of the highest possible standard, no corners cut. This is the library we will be using internally for a long time.

Relates to issue: #36

Given that I am a ‘Negotiator’ and i have logged into the SMB App, I want to click on ‘Read more’ from the ‘Get Started’ section to view a helper guide.

Component from elements: https://reapit.github.io/elements/?path=/story/helpguide--primary

• Should be on it’s own route /getstarted
• Content below/images TBC

Content

Step 1: Setting up your Office(s).

Setup your office and additional offices in your company by accessing ‘Offices’. Here you can set your ‘Global Settings’, configure your ‘Areas’ and third-party software ‘Integrations’.

Step 2: Adding Users.

Add your Negotiators, Property Managers and Admin access through ‘Users’. You can add, delete or transfer users between Offices. You’ll need to setup at least 1 admin user before installing the software.

Step 3: Adding Sources and Referrals.

Configure your Lead Sources, Advertising Publishers and add third party Referrals from the ‘Sources’ tab. You can come back any time and add new sources when you need to.

Step 4: Branding your Templates and selecting your Portals.

Personalise your templates & brand your brochures. From the ‘Marketing’ tab you can set your set your company colours, upload your logo and choose which Portals you want to send to.

Step 5: That’s it! Let’s get started.

You can now start the wizard by clicking on ‘Start Setup’ below. We will walk you through the steps and in no time at all, you’ll be ready to install the latest version of Agency Cloud.

Button: Start Setup

Images TBC

Location: https://dev.marketplace.reapit.com/developer/submit-app

Summary:
When a user attempts to add an app using an app name that is already in use, we display this via a notification. The notification needs to be clearer.

Steps to reproduce:
Login as a ‘Developer’ and submit an app with App Name example ‘This is an app’. Once submitted, try and submit another app with the exact same App Name example ‘This is an app’. A notification will appear ‘Something went wrong fetching the data’.

Expected Results:
Login as a ‘Developer’ and submit an app with App Name ‘This is an app’. Once submitted, try and submit another app with the same App Name ‘This is an app’. The following notification should appear: ‘The App name you have chosen has already been used, please try again with a different name.’

Should display when the API description is ‘description: "App name has already been registered, please choose a new name"

See example:

Actual Results:
Message displayed is ‘Something went wrong fetching the data’

The TS-Defintions repo should be a package within the main Foundations repo

• Should preserve git history
• Should archive old project
• Should normalise dependencies and tooling (tests, linting etc) with base repo
• Should verify existing pipeline is working by pushing to NPM

Task: Is to create the end to end test for the 'Welcome Message' after first time login on the 'Developer Portal'

Steps:

• Mock the cookie COOKIE_FIRST_TIME_LOGIN
• Login using the developer account
• Observe that welcome message is shown
• Logout
• Login using the created account again
• Observe that welcome message is not shown

Dependent on ticket: #71

Summary: Create/insert data react table into the ‘Users’ page on the SMB App, with the following headings:

• Use spreadsheet component: https://reapit.github.io/elements/?path=/story/spreadsheet--basic

• Endpoint: / Negotiators

Columns

• ColumnsName* - First Name & Surname

• Telephone* - Number only

• Email* - Apply email validation

• Job Title* - Free text field

• Primary Office* - (drop down menu populated from \offices )

• Status – Check box ‘Is Active’ - Ticked if ‘active’ is true, unticked if ‘active’ is false

• The above columns with * indicates they are required fields and must be completed. If a row has been created and those fields are missing, should indicate this by changing the background of the cell. Use colour and opacity settings from https://reapit.github.io/elements/?path=/story/helper--warning

• Should not post a mutation to the server unless the required fields have been completed.

• Adding a user is dependent on an ‘Office’ existing, as the user needs to be assigned to an Office.

• If an office does not exist, should not be able to add any information so should disable table, add new & upload file buttons.

• Should include message above the table: It looks as though you haven’t yet added an Office, please click here (insert route to \offices) to add an Office before you can add a User.

• Button: Add New – should add another row and user record when clicked

• Editing an item should updated the record

• Buttons to ‘Upload File’ and ‘Download file’

• Should use Apollo GQL Queries and mutations, tasks to write these on the server side See:

See mock up:

Summary: There is a security issue within Elements that requires an update to the 'handlebars' version.

See below:

Dependent on Jest release: jestjs/jest#9355

Background

Elements UI library is being refactored to ensure better DX, UX and a more lightweight, flexible library with a more consistent API

Task

• Should be part of the input module ie Input.Editor
• Migrate component in line with overall specification here: https://github.com/reapit/foundations/blob/master/packages/elements-next/src/index.mdx
• Special concern should be given to the Specification section above, consistency, reusability and lightweight are our driving principles
• Should be deployed to new Elements Next documentation app in Docz library.
• Both code, testing and documentation to be of the highest possible standard, no corners cut. This is the library we will be using internally for a long time.

Given that I am a ‘Negotiator’ and I am logged into the SMB App, when I click ‘Marketing’ from the nav bar, I can then see tabs for Templates, Portals and Web Feed

Task: To create a ‘Marketing’ page from the ‘Marketing’ option in the nav bar (route \marketing)

Header: Marketing
Tabs (each tab should be on it’s on own URL):

• Templates (route marketing\templates)
• Portals (route marketing\portals)
• Web Feed (route marketing\webfeed)
  Wording: TBC (use lorem ipsum)

See mock up:

Background

Elements UI library is being refactored to ensure better DX, UX and a more lightweight, flexible library with a more consistent API

Task

• Components should be re-usable but not part of main styleguide
• Should largely rely on existing solution of Pell & Himalaya - refactor as appropriate
• Migrate from Elements v2 to Utils/web

Given that I am ‘Negotiator’ and I have just logged into the SMB App, I want to see 3 options to choose from.

Task to create a landing page when a user logs in.

• Should be on a \home URL

See mock up:

Page Heading: Welcome
Sub text: TBC (use lorem ipsum)

• Using the same format/layout as https://dev.marketplace.reapit.com/developer/help
• Create 3 sections:

Heading: Get Started.
Body Text: TBC (use lorem ipsum)
Button: Read More
Image:

Heading: Install Agency Cloud.
Body Text: TBC (use lorem ipsum)
Button: Install
Image:

Heading: Support
Body Text: TBC (use lorem ipsum)
Button: Contact
Image:

Summary: Currently we are storing the images as URL's in the metadata. When available from the Backend team, we need to update the component in the following places.

Task: is to update the File Uploader component when available.

Locations:

• Primary ID
• Secondary ID
• Address History
• Declaration and Risk Management

Given that I am a ‘Negotiator’ and I am logged into the SMB App, when I click ‘Sources’ from the nav bar, I can then see tabs for Sources & Advertising and Referrals

Task: To create a ‘Sources’ page from the ‘Sources’ option in the nav bar (route \sources)

Header: Sources
Tabs (each tab should be on its on URL):

• Sources & Advertising (route sources\sourcesandads
• Referrals (route sources\referrals)
  Wording: TBC (use lorem ipsum)

See mock up:

• Create env for the SMB Project: dev.smb-app.reapit.com & smb-app.reapit.com
• Should use Github Actions
• Should run unit and e2e tests before deploying
• Should deploy to development when merging to master
• Should deploy to prod when pushing a tag as per other apps

Background

Elements UI library is being refactored to ensure better DX, UX and a more lightweight, flexible library with a more consistent API

Task

• Task in line with overall specification TBC
• Create comprehensive list of CSS variables to support theming that can be referenced across the styleguide and loaded globally
• Allow for an overrides theme to be added so users can customise the base variables to provide a theme

Summary: Errors created in the App Store and GEO Diary are not being captured by Sentry.

Expected Behaviour: Errors created should be logged and notifications sent through the channel

Errors & Images:

The following error was created in App Store by trying to submit an app whilst reaching the limit of 'Unlisted' apps:

The following error was created in GEO Diary by trying to cancel an appointment (_etag issue):

Relates to ticket: #64

• Query Apollo with mutation to add, edit and delete offices

• The documentation for the 'Open Source Foundations project needs updating and documenting ahead of release
• Project needs full review, documentation written and tidied up ahead of release

Dependent on ticket : #62

Summary: To add the spreadsheet component (https://reapit.github.io/elements/?path=/story/spreadsheet--basic) to the 'Offices' page and link to endpoint: / Offices

Columns should contain the following headings with the correct formatting options:

• Office Name* – Field should allow any text

• Building Number - Field should allow any text

• Address 1* - Field should allow any text

• Address 2 - Field should allow any text

• Address 3 - Field should allow any text

• Address 4 - Field should allow any text

• Postcode* – Postcode validation (TBC)

• Telephone* – Number only

• Fax – Number only

• Email* – Email validation

• Postcode referrals – TBC

• The above columns with * indicates they are required fields and must be completed. If a row has been created and those fields are missing, should indicate this by changing the background of the cell. Use colour and opacity settings from https://reapit.github.io/elements/?path=/story/helper--warning

• Should not post a mutation to the server unless the required fields have been completed.

• Button: Add New – should add another row and office record when clicked

• Editing an item should updated the record

• Buttons to ‘Upload File’ and ‘Download file’

• Should use Apollo GQL Queries and mutations, tasks to write these on the server side

See mock up:

Given that I am a ‘Negotiator’ and I am logged into the SMB App, when I click ‘Offices’ from the nav bar, I want to have the option to access additional pages such as ‘Offices/Areas/Global Settings/Integrations.

Task: To create a ‘Offices’ page from the ‘Offices’ option in the nav bar (route \offices)

• Page should include the following:

Header: Offices
Sub Text: TBC (use lorem ipsum)
Tabs: Offices, Areas, Global Settings & Integrations

• Each tab should be on it’s on own URL:
  Offices (route \offices)
  Areas (route offices\areas)
  Global Settings (route offices\globalsettings)
  Integrations (route offices\integrations)

See mock up:

The Cognito Auth repo should be a package within the main Foundations repo

• Should preserve git history
• Should archive old project
• Should normalise dependencies and tooling (tests, linting etc) with base repo
• Should verify existing pipeline is working by pushing to NPM

• Migrate inputs to v2.0 project
• CSS should remain identical, with same variants and options
• Important that it is heavily tested for no regressions
• Use variables where possible for everything, no magic numbers and values
• Should not be in bundle for now

The Config Manager repo should be a package within the main Foundations repo

Should preserve git history
Should archive old project
Should normalise dependencies and tooling (tests, linting etc) with base repo
Should have a very basic pipeline that publishes master to NPM (Currently Manual)

Relates to ticket:: #71

• Query Apollo with mutation to add and edit Negotiators

• The API tab in the Developers portal needs updating to reflect the new auth flow.
• Also require versioning section.
• Craig to supply when the new auth flow is finalised.
• Task is to mark up the content and add to the API documentation page (https://dev.marketplace.reapit.com/developer/swagger) when it becomes available.

Background

Elements UI library is being refactored to ensure better DX, UX and a more lightweight, flexible library with a more consistent API

Task

• To include text, password, number, email, date, time, tel, checkbox, radio, text area, file, select
• Include a separate styled label component
• Include a separate styled form component
• Create component in line with overall specification TBC
• Should implement inputs from Figma styleguide
• Should be flexible to allow use with any React Form or validation library by way of passing props to component
• Should show each component as a molecule story, as well as a form layout example with all inputs in it

• Pages and setup to be confirmed

Background

Elements UI library is being refactored to ensure better DX, UX and a more lightweight, flexible library with a more consistent API

Task

• Out of scope for Elements but there should be an image cropping an upload tool based on Elements v3 file input for use in internal projects
• Should be exported from Utils / browser package

Location: https://dev.lifetime-legal-app.reapit.com/

Summary: The backend team have made changes to the /Contact endpoint which will require updates to the LTL App.

IMPORTANT See comment for details of code fixes

Contact Service

Communication

• Previously the communication object contained ‘homephone’, ‘workphone’, ‘mobilephone’ and ‘email ‘
• These are now separate fields so we will need to update the frontend to reflect this

Previous Setup:

New setup:

Addresses

• Previously the Primary (0) and Secondary (1) addresses were contained within the object ‘addresses’. They are now separate fields ‘primaryAddress’ & ‘secondaryAddress’.
• Primary and Secondary Addresses are used in the ‘Address History’ section on both AML and LTL.

Previous setup:

identityCheck service:

• Previously the documents for the primary and secondary ID were contained in the object ‘documents’ and were listed as 0 and 1.
• Following the changes, they are now separate fields ‘document1’ and ‘document2’. We will need to update ‘AML and LTL’ primary and secondary id sections to reflect this.

Previous:

New:

Given that I am a ‘Negotiator’ and I am using my 'Client' login credentials, I want to login to the SMB App

Task is to integrate with Reapit Connect. As per Geo Diary, AML etc. Will need to submit app via dev portal and register relevant permissions and URLs as per normal flow (see docs), so the app will integrate properly.

• Should create new simple pipeline so project is available as an NPM package (should simply deploy a tag)
• Should have a GraphQL app version on the CLI
• Should have a no-redux version on the CLI
• Should have an "Is Foundations" project for internal use, so a new scaffolder app does not have to have it's own dependencies i.e. it can rely on the packages in the main manifest
• Should be updated to reflect latest changes to build scripts, webpack, tsconfig, jest etc to normalise with rest of project