refactor: simplify AttestationFormData and QuestionFormData types, add base types for API

Author: jescalada

src/proxy/actions/Action.ts

@@ -1,7 +1,6 @@
 import { processGitURLForNameAndOrg, processUrlPath } from '../routes/helper';
 import { Step } from './Step';
-import { CommitData } from '../processors/types';
-import { AttestationFormData } from '../../ui/types';
+import { Attestation, CommitData } from '../processors/types';
 
 /**
  * Class representing a Push.
@@ -34,7 +33,7 @@ class Action {
   author?: string;
   user?: string;
   userEmail?: string;
-  attestation?: AttestationFormData;
+  attestation?: Attestation;
   lastStep?: Step;
   proxyGitPath?: string;
   newIdxFiles?: string[];

src/proxy/processors/types.ts

@@ -1,3 +1,4 @@
+import { Question } from '../../config/generated/config';
 import { Action } from '../actions';
 
 export interface Processor {
@@ -9,6 +10,15 @@ export interface ProcessorMetadata {
   displayName: string;
 }
 
+export type Attestation = {
+  reviewer: {
+    username: string;
+    gitAccount: string;
+  };
+  timestamp: string | Date;
+  questions: Question[];
+};
+
 export type CommitContent = {
   item: number;
   type: number;

src/ui/types.ts

@@ -1,6 +1,8 @@
 import { Action } from '../proxy/actions';
 import { Step } from '../proxy/actions/Step';
 import { Repo } from '../db/types';
+import { Attestation } from '../proxy/processors/types';
+import { Question } from '../config/generated/config';
 
 export interface PushActionView extends Action {
   diff: Step;
@@ -12,24 +14,11 @@ export interface RepoView extends Repo {
   dateCreated?: string;
 }
 
-export interface QuestionFormData {
-  label: string;
+export interface QuestionFormData extends Question {
   checked: boolean;
-  tooltip: {
-    text: string;
-    links?: {
-      text: string;
-      url: string;
-    }[];
-  };
 }
 
-export interface AttestationFormData {
-  reviewer: {
-    username: string;
-    gitAccount: string;
-  };
-  timestamp: string | Date;
+export interface AttestationFormData extends Attestation {
   questions: QuestionFormData[];
 }
 

src/ui/views/PushDetails/PushDetails.tsx

@@ -22,7 +22,7 @@ import { getPush, authorisePush, rejectPush, cancelPush } from '../../services/g
 import { CheckCircle, Visibility, Cancel, Block } from '@material-ui/icons';
 import Snackbar from '@material-ui/core/Snackbar';
 import Tooltip from '@material-ui/core/Tooltip';
-import { PushActionView } from '../../types';
+import { AttestationFormData, PushActionView } from '../../types';
 import { trimPrefixRefsHeads, trimTrailingDotGit } from '../../../db/helper';
 import { generateEmailLink, getGitProvider } from '../../utils';
 import UserLink from '../../components/UserLink/UserLink';
@@ -233,7 +233,7 @@ const Dashboard: React.FC = () => {
 
                   {!push.autoApproved && (
                     <AttestationView
-                      data={push.attestation}
+                      data={push.attestation as AttestationFormData}
                       attestation={attestation}
                       setAttestation={setAttestation}
                     />