Merge pull request #1509 from CaliOpen/frontend/fix_compile

iamdey · web-flow · commit 2666520b2473 · 2021-03-19T15:11:30.000+01:00
[frontend] fix ts error related to changes from develop branch
diff --git a/src/frontend/web_application/package.json b/src/frontend/web_application/package.json
@@ -131,13 +131,13 @@
     "@types/lingui__react": "^2.8.3",
     "@types/lodash": "^4.14.168",
     "@types/openpgp": "^4.4.15",
-    "@types/react": "^17.0.1",
-    "@types/react-dom": "^17.0.0",
+    "@types/react": "^17.0.3",
+    "@types/react-dom": "^17.0.2",
     "@types/react-redux": "^7.1.16",
     "@types/react-router-dom": "^5.1.7",
     "@types/redux": "^3.6.0",
-    "@typescript-eslint/eslint-plugin": "^4.15.0",
-    "@typescript-eslint/parser": "^4.15.0",
+    "@typescript-eslint/eslint-plugin": "^4.18.0",
+    "@typescript-eslint/parser": "^4.18.0",
     "autoprefixer": "^9.7.6",
     "axios-mock-adapter": "^1.18.1",
     "babel-core": "^7.0.0-bridge.0",
@@ -193,10 +193,10 @@
     "stylelint-order": "^4.1.0",
     "stylelint-scss": "^3.19.0",
     "stylelint-webpack-plugin": "^2.1.1",
-    "ts-loader": "^8.0.17",
-    "typescript": "^4.1.5",
+    "ts-loader": "^8.0.18",
+    "typescript": "^4.2.3",
     "uglifyjs-webpack-plugin": "^2.2.0",
-    "webpack": "^5.23.0",
+    "webpack": "^5.26.2",
     "webpack-cli": "^4.5.0",
     "webpack-dev-server": "^3.11.2",
     "webpack-merge": "^5.7.3",
diff --git a/src/frontend/web_application/src/modules/contact/types.d.ts b/src/frontend/web_application/src/modules/contact/types.d.ts
@@ -1,14 +1,21 @@
+import { PI, PrivacyFeature } from 'src/modules/pi/types';
+
 // Entity ---------------------------------------
-export interface ContactCommon {
-  contact_id: string;
-  title: string;
-  family_name: string;
+interface NewPostalAddress {
+  address_id?: string;
+  city: string;
+  country?: string;
+  is_primary?: boolean;
+  label?: string;
+  postal_code?: string;
+  region?: string;
+  street?: string;
+  type?: string;
 }
 
-interface PrivacyIndex {
-  technic: number;
-  context: number;
-  comportment: number;
+interface PostalAddress extends NewPostalAddress {
+  address_id: string;
+  city: string;
 }
 
 interface Email {
@@ -19,32 +26,112 @@ interface Email {
   address: string;
   type: string;
 }
-export interface ContactPayload extends ContactCommon {
-  // FIXME: types are not yet verified
-  addresses: string[];
-  privacy_features: {};
-  phones: string[];
-  date_insert: string;
-  identities: string[];
-  user_id?: string;
+
+interface NewSocialIdentity {
+  infos?: { [key: string]: any };
+  name: string;
+  type: string;
+}
+
+interface SocialIdentity extends NewSocialIdentity {
+  social_id: string;
+}
+
+interface NewOrganization {
+  department?: string;
+  is_primary?: boolean;
+  job_description?: string;
+  label?: string;
+  name: string;
+  title?: string;
+  type?: string;
+}
+
+interface Organization extends NewOrganization {
+  deleted?: boolean;
+  organization_id: string;
+}
+
+interface NewPhone {
+  is_primary?: boolean;
+  number: string;
+  type?: string;
+  uri?: string;
+}
+
+interface Phone extends NewPhone {
+  phone_id: string;
+  normalized_number?: string;
+}
+
+interface NewIM {
+  address: string;
+  is_primary?: boolean;
+  label?: string;
+  protocol?: string;
+  type?: string;
+}
+
+interface IM extends NewIM {
+  im_id: string;
+}
+
+interface NewPublicKey {
+  key: string; //description : "DER or PEM key, base64 encoded"
+  label: string;
+}
+
+interface PublicKey extends NewPublicKey {
+  alg?: string;
+  crv?: string;
+  date_insert?: string; //format: date-time
+  date_update?: string; //format: date-time
+  emails?: string[];
+  expire_date?: string; //format: date-time
+  fingerprint?: string;
+  kty?: string;
+  key_id: string;
+  type?: string;
+  resource_id: string;
+  resource_type?: string;
+  size?: number; //format: int32
+  use?: string;
+  user_id: string;
+  x?: number; //format: int64
+  y?: number; //format: int64
+}
+
+export interface ContactCommon {
   additional_name?: string;
+  addresses?: PostalAddress[];
+  avatar?: string;
+  contact_id: string;
+  date_insert?: string;
   date_update?: string;
-  organizations: string[];
-  ims: string[];
-  given_name: string;
-  name_prefix?: string;
-  deleted: number; // ?
-  pi: PrivacyIndex;
-  tags: string[];
+  deleted?: string; // date-time
+  emails?: Email[];
+  family_name?: string;
+  given_name?: string;
+  groups?: string[];
+  identities?: SocialIdentity[];
+  ims?: IM[];
   infos?: {
+    // object
     birthday?: string;
   };
-  emails: Email[];
-  family_name: string;
+  name_prefix?: string;
   name_suffix?: string;
-  avatar: string;
-  public_keys: string[];
+  organizations?: Organization[];
+  phones?: Phone[];
+  pi?: PI;
+  privacy_features?: PrivacyFeature;
+  public_keys?: PublicKey[];
+  tags?: string[];
+  title?: string;
+  user_id: string;
 }
+
+export interface ContactPayload extends ContactCommon {}
 //  ---------------------------------------------
 
 export type TSortDir = 'ASC' | 'DESC';
diff --git a/src/frontend/web_application/src/modules/pi/types.d.ts b/src/frontend/web_application/src/modules/pi/types.d.ts
@@ -0,0 +1,11 @@
+export interface PI {
+  technic: number;
+  context: number;
+  comportment: number;
+  version: number;
+  // [additional: string]: any, // XXX: not sure how to type `additionalProperties`
+}
+
+export interface PrivacyFeature {
+  [key: string]: any;
+}
diff --git a/src/frontend/web_application/src/modules/user/components/UserInfo/UserInfo.spec.tsx b/src/frontend/web_application/src/modules/user/components/UserInfo/UserInfo.spec.tsx
@@ -3,7 +3,7 @@ import { render, screen, waitFor } from '@testing-library/react';
 import { rest } from 'msw';
 import { AllProviders } from 'test/providers';
 import { server } from 'test/server';
-import { user } from 'test/msw-handlers/user';
+import { generateUser } from 'test/fixtures/user';
 import { settings } from 'test/msw-handlers/settings';
 import WithUser from '../WithUser';
 import UserInfo from './index';
@@ -18,6 +18,7 @@ const Comp = () => (
 );
 
 describe('component UserInfo', () => {
+  const user = generateUser();
   beforeEach(() => {
     server.use(
       rest.get('/api/v1/me', (req, res, ctx) => {
@@ -37,6 +38,6 @@ describe('component UserInfo', () => {
     // TODO: rm (after using hooks)
     //  Force re-render due to With<Thing> fetching
     await waitFor(() => screen.findByText('loading'));
-    await waitFor(() => screen.findByText(user.name));
+    await waitFor(() => screen.findByText(user.name || 'fail'));
   });
 });
diff --git a/src/frontend/web_application/src/modules/user/types.d.ts b/src/frontend/web_application/src/modules/user/types.d.ts
@@ -1,10 +1,20 @@
 import { PatchPayload } from 'src/types';
 import { ContactCommon } from 'src/modules/contact/types';
+import { PI, PrivacyFeature } from 'src/modules/pi/types';
 
 // Entity ---------------------------------------
 export interface UserPayload {
-  user_id: string;
   contact: ContactCommon;
+  date_insert?: string; // format: date-time
+  family_name?: string;
+  given_name?: string;
+  name?: string;
+  password?: string;
+  params?: object;
+  privacy_features?: PrivacyFeature;
+  pi?: PI;
+  user_id: string;
+  recovery_email?: string;
 }
 
 export type UserPatchPayload = PatchPayload<UserPayload>;
diff --git a/src/frontend/web_application/src/scenes/UserSecurity/components/OpenPGPGenerateForm.tsx b/src/frontend/web_application/src/scenes/UserSecurity/components/OpenPGPGenerateForm.tsx
@@ -39,12 +39,13 @@ function OpenPGPGenerateForm({ i18n, cancel, onSuccess }: Props) {
   const [isLoading, setIsLoading] = React.useState<boolean>(false);
   const [errors, setErrors] = React.useState<undefined | string[]>();
 
-  const user = useUser();
+  const { user } = useUser();
 
-  const emailOptions = user?.contact.emails.map((email) => ({
-    label: email.address,
-    value: email.address,
-  }));
+  const emailOptions =
+    user?.contact.emails?.map((email) => ({
+      label: email.address,
+      value: email.address,
+    })) || [];
 
   const errorsLabels = {};
 
@@ -63,6 +64,9 @@ function OpenPGPGenerateForm({ i18n, cancel, onSuccess }: Props) {
 
   const handleGenerateSubmit = async (event) => {
     event.preventDefault();
+    if (!user) {
+      return;
+    }
     setIsLoading(true);
     const { passphrase, email } = generateValues;
     const manager = await getPGPManager();
diff --git a/src/frontend/web_application/src/scenes/UserSecurity/components/OpenPGPImportForm.tsx b/src/frontend/web_application/src/scenes/UserSecurity/components/OpenPGPImportForm.tsx
@@ -63,7 +63,7 @@ function OpenPGPImportForm({ i18n, cancel, onSuccess }: Props) {
   const [isLoading, setIsLoading] = React.useState<boolean>(false);
   const [errors, setErrors] = React.useState<Errors>({});
 
-  const user = useUser();
+  const { user } = useUser();
 
   const errorsLabels = {
     [ERROR_REQUIRED]: i18n._(
@@ -121,6 +121,10 @@ function OpenPGPImportForm({ i18n, cancel, onSuccess }: Props) {
 
     const errors = validate(importValues);
 
+    if (!user) {
+      return;
+    }
+
     if (errors) {
       setErrors(errors);
       return;
diff --git a/src/frontend/web_application/src/scenes/UserSecurity/components/OpenPGPPrivateKeys/index.tsx b/src/frontend/web_application/src/scenes/UserSecurity/components/OpenPGPPrivateKeys/index.tsx
@@ -19,8 +19,16 @@ const FORM_TYPE_GENERATE = 'generate';
 const FORM_TYPE_IMPORT = 'import';
 type FormType = typeof FORM_TYPE_GENERATE | typeof FORM_TYPE_IMPORT;
 
+// cf. getPrimaryKeysByFingerprint
+type KeysByFingerPrint = {
+  [fingerprint: string]: {
+    publicKeyArmored?: string;
+    privateKeyArmored?: string;
+  };
+};
+
 function OpenPGPPrivateKeys() {
-  const [keys, setKeys] = React.useState();
+  const [keys, setKeys] = React.useState<KeysByFingerPrint>();
   const [editMode, setEditMode] = React.useState(false);
   const [formType, setFormType] = React.useState<FormType>(FORM_TYPE_GENERATE);
 
@@ -61,8 +69,8 @@ function OpenPGPPrivateKeys() {
         <OpenPGPKey
           key={fingerprint}
           className="m-account-openpgp__keys"
-          publicKeyArmored={key.publicKeyArmored}
-          privateKeyArmored={key.privateKeyArmored}
+          publicKeyArmored={key.publicKeyArmored || ''}
+          privateKeyArmored={key.privateKeyArmored || ''}
           editMode={editMode}
           onDeleteKey={handleDeleteKey}
         />
diff --git a/src/frontend/web_application/test/fixtures/contacts/data.json b/src/frontend/web_application/test/fixtures/contacts/data.json
diff --git a/src/frontend/web_application/test/fixtures/user/data.json b/src/frontend/web_application/test/fixtures/user/data.json
diff --git a/src/frontend/web_application/test/fixtures/user/index.ts b/src/frontend/web_application/test/fixtures/user/index.ts
diff --git a/src/frontend/web_application/yarn.lock b/src/frontend/web_application/yarn.lock
