Merge pull request #85 from antoniomuso/refactor/shared-commons-types

refactor: shared common types
drodil · Aug 1, 2023 · d6561ef · d6561ef
2 parents 8dfefc5 + 0ba5d30
commit d6561ef
Show file tree

Hide file tree

Showing 8 changed files with 114 additions and 164 deletions.
diff --git a/plugins/qeta-backend/src/database/DatabaseQetaStore.ts b/plugins/qeta-backend/src/database/DatabaseQetaStore.ts
@@ -4,21 +4,21 @@ import {
 } from '@backstage/backend-common';
 import { Knex } from 'knex';
 import {
-  Answer,
-  Attachment,
   AttachmentParameters,
   MaybeAnswer,
   MaybeQuestion,
   QetaStore,
-  Question,
   Questions,
   QuestionsOptions,
   TagResponse,
-  Vote,
 } from './QetaStore';
 import {
   Statistic,
   StatisticsRequestParameters,
+  Vote,
+  Question,
+  Answer,
+  Attachment,
 } from '@drodil/backstage-plugin-qeta-common';
 
 const migrationsDir = resolvePackagePath(

diff --git a/plugins/qeta-backend/src/database/QetaStore.ts b/plugins/qeta-backend/src/database/QetaStore.ts
@@ -2,60 +2,11 @@ import {
   Statistic,
   StatisticsRequestParameters,
 } from '@drodil/backstage-plugin-qeta-common';
-
-export interface Question {
-  id: number;
-  author: string;
-  title: string;
-  content: string;
-  created: Date;
-  updated?: Date;
-  updatedBy?: string;
-  score: number;
-  views: number;
-  answersCount: number;
-  correctAnswer: boolean;
-  favorite: boolean;
-  ownVote?: number;
-  tags?: string[];
-  entities?: string[];
-  answers?: Answer[];
-  own?: boolean;
-  votes?: Vote[];
-  trend?: number;
-  comments?: Comment[];
-}
-
-export interface Answer {
-  id: number;
-  questionId: number;
-  author: string;
-  content: string;
-  correct: boolean;
-  created: Date;
-  updated?: Date;
-  updatedBy?: string;
-  score: number;
-  ownVote?: number;
-  own?: boolean;
-  votes?: Vote[];
-  comments?: Comment[];
-}
-
-export interface Vote {
-  author: string;
-  score: number;
-  timestamp: Date;
-}
-
-export interface Comment {
-  author: string;
-  content: string;
-  created: Date;
-  own?: boolean;
-  updated?: Date;
-  updatedBy?: string;
-}
+import type {
+  Question,
+  Answer,
+  Attachment,
+} from '@drodil/backstage-plugin-qeta-common';
 
 export type MaybeAnswer = Answer | null;
 export type MaybeQuestion = Question | null;
@@ -96,18 +47,7 @@ export interface TagResponse {
   tag: string;
   questionsCount: number;
 }
-export interface Attachment {
-  id: number;
-  uuid: string;
-  locationType: string;
-  locationUri: string;
-  path: string;
-  binaryImage: Buffer;
-  mimeType: string;
-  extension: string;
-  creator: string;
-  created: Date;
-}
+
 export interface AttachmentParameters {
   uuid: string;
   locationType: string;

diff --git a/plugins/qeta-backend/src/service/router.test.ts b/plugins/qeta-backend/src/service/router.test.ts
@@ -19,7 +19,12 @@ import express from 'express';
 import request from 'supertest';
 
 import { createRouter } from './router';
-import { Answer, QetaStore, Question, Comment } from '../database/QetaStore';
+import { QetaStore } from '../database/QetaStore';
+import {
+  Answer,
+  Question,
+  Comment,
+} from '@drodil/backstage-plugin-qeta-common';
 import {
   BackstageIdentityResponse,
   IdentityApi,
@@ -91,6 +96,7 @@ const answer: Answer = {
 };
 
 const comment: Comment = {
+  id: 23,
   author: 'user',
   content: 'content',
   created: new Date('2022-01-01T00:00:00Z'),

diff --git a/plugins/qeta-backend/src/service/routes/attachments.ts b/plugins/qeta-backend/src/service/routes/attachments.ts
@@ -1,6 +1,6 @@
 import { Router } from 'express';
 import { RouterOptions } from '../router';
-import { Attachment } from '../../database/QetaStore';
+import { Attachment } from '@drodil/backstage-plugin-qeta-common';
 import multiparty from 'multiparty';
 import FilesystemStoreEngine from '../upload/filesystem';
 import DatabaseStoreEngine from '../upload/database';

diff --git a/plugins/qeta-backend/src/service/upload/filesystem.ts b/plugins/qeta-backend/src/service/upload/filesystem.ts
@@ -1,7 +1,8 @@
 import * as fs from 'fs';
 import { v4 as uuidv4 } from 'uuid';
 import { Config } from '@backstage/config';
-import { Attachment, QetaStore } from '../../database/QetaStore';
+import { QetaStore } from '../../database/QetaStore';
+import { Attachment } from '@drodil/backstage-plugin-qeta-common';
 import { File } from '../types';
 
 type Options = {

diff --git a/plugins/qeta-common/src/types.ts b/plugins/qeta-common/src/types.ts
@@ -19,3 +19,71 @@ export interface StatisticsRequestParameters {
   author?: string;
   options?: StatisticsOptions;
 }
+
+export interface Question {
+  id: number;
+  author: string;
+  title: string;
+  content: string;
+  created: Date;
+  updated?: Date;
+  updatedBy?: string;
+  score: number;
+  views: number;
+  answersCount: number;
+  correctAnswer: boolean;
+  favorite: boolean;
+  ownVote?: number;
+  tags?: string[];
+  entities?: string[];
+  answers?: Answer[];
+  own?: boolean;
+  votes?: Vote[];
+  trend?: number;
+  comments?: Comment[];
+}
+
+export interface Answer {
+  id: number;
+  questionId: number;
+  author: string;
+  content: string;
+  correct: boolean;
+  created: Date;
+  updated?: Date;
+  updatedBy?: string;
+  score: number;
+  ownVote?: number;
+  own?: boolean;
+  votes?: Vote[];
+  comments?: Comment[];
+}
+
+export interface Vote {
+  author: string;
+  score: number;
+  timestamp: Date;
+}
+
+export interface Comment {
+  id: number;
+  author: string;
+  content: string;
+  created: Date;
+  own?: boolean;
+  updated?: Date;
+  updatedBy?: string;
+}
+
+export interface Attachment {
+  id: number;
+  uuid: string;
+  locationType: string;
+  locationUri: string;
+  path: string;
+  binaryImage: Buffer;
+  mimeType: string;
+  extension: string;
+  creator: string;
+  created: Date;
+}
diff --git a/plugins/qeta/src/api/QetaClient.ts b/plugins/qeta/src/api/QetaClient.ts
@@ -8,16 +8,16 @@ import {
 import { CustomErrorBase } from '@backstage/errors';
 import {
   AnswerRequest,
-  AnswerResponse,
   AnswerResponseBody,
   AttachmentResponseBody,
   QuestionRequest,
-  QuestionResponse,
   QuestionResponseBody,
   QuestionsResponse,
   QuestionsResponseBody,
   TagResponse,
 } from './types';
+
+import { Answer, Question } from '@drodil/backstage-plugin-qeta-common';
 import omitBy from 'lodash/omitBy';
 import isEmpty from 'lodash/isEmpty';
 import {
@@ -109,7 +109,7 @@ export class QetaClient implements QetaApi {
     return data;
   }
 
-  async postQuestion(question: QuestionRequest): Promise<QuestionResponse> {
+  async postQuestion(question: QuestionRequest): Promise<Question> {
     const response = await this.fetchApi.fetch(
       `${await this.getBaseUrl()}/questions`,
       {
@@ -127,10 +127,7 @@ export class QetaClient implements QetaApi {
     return data;
   }
 
-  async commentQuestion(
-    id: number,
-    content: string,
-  ): Promise<QuestionResponse> {
+  async commentQuestion(id: number, content: string): Promise<Question> {
     const response = await this.fetchApi.fetch(
       `${await this.getBaseUrl()}/questions/${id}/comments`,
       {
@@ -151,7 +148,7 @@ export class QetaClient implements QetaApi {
   async deleteQuestionComment(
     questionId: number,
     id: number,
-  ): Promise<QuestionResponse> {
+  ): Promise<Question> {
     const response = await this.fetchApi.fetch(
       `${await this.getBaseUrl()}/questions/${questionId}/comments/${id}`,
       {
@@ -167,7 +164,7 @@ export class QetaClient implements QetaApi {
     return data;
   }
 
-  async getQuestion(id?: string): Promise<QuestionResponse> {
+  async getQuestion(id?: string): Promise<Question> {
     if (!id) {
       throw new QetaError('Invalid id provided', undefined);
     }
@@ -191,7 +188,7 @@ export class QetaClient implements QetaApi {
     return (await response.json()) as TagResponse[];
   }
 
-  async voteQuestionUp(id: number): Promise<QuestionResponse> {
+  async voteQuestionUp(id: number): Promise<Question> {
     if (!id) {
       throw new QetaError('Invalid id provided', undefined);
     }
@@ -207,7 +204,7 @@ export class QetaClient implements QetaApi {
     return data;
   }
 
-  async voteQuestionDown(id: number): Promise<QuestionResponse> {
+  async voteQuestionDown(id: number): Promise<Question> {
     if (!id) {
       throw new QetaError('Invalid id provided', undefined);
     }
@@ -223,7 +220,7 @@ export class QetaClient implements QetaApi {
     return data;
   }
 
-  async favoriteQuestion(id: number): Promise<QuestionResponse> {
+  async favoriteQuestion(id: number): Promise<Question> {
     if (!id) {
       throw new QetaError('Invalid id provided', undefined);
     }
@@ -239,7 +236,7 @@ export class QetaClient implements QetaApi {
     return data;
   }
 
-  async unfavoriteQuestion(id: number): Promise<QuestionResponse> {
+  async unfavoriteQuestion(id: number): Promise<Question> {
     if (!id) {
       throw new QetaError('Invalid id provided', undefined);
     }
@@ -277,7 +274,7 @@ export class QetaClient implements QetaApi {
     questionId: number,
     id: number,
     content: string,
-  ): Promise<AnswerResponse> {
+  ): Promise<Answer> {
     const response = await this.fetchApi.fetch(
       `${await this.getBaseUrl()}/questions/${questionId}/answers/${id}/comments`,
       {
@@ -299,7 +296,7 @@ export class QetaClient implements QetaApi {
     questionId: number,
     answerId: number,
     id: number,
-  ): Promise<AnswerResponse> {
+  ): Promise<Answer> {
     const response = await this.fetchApi.fetch(
       `${await this.getBaseUrl()}/questions/${questionId}/answers/${answerId}/comments/${id}`,
       {
@@ -315,7 +312,7 @@ export class QetaClient implements QetaApi {
     return data;
   }
 
-  async voteAnswerUp(questionId: number, id: number): Promise<AnswerResponse> {
+  async voteAnswerUp(questionId: number, id: number): Promise<Answer> {
     if (!id || !questionId) {
       throw new QetaError('Invalid id provided', undefined);
     }
@@ -331,10 +328,7 @@ export class QetaClient implements QetaApi {
     return data;
   }
 
-  async voteAnswerDown(
-    questionId: number,
-    id: number,
-  ): Promise<AnswerResponse> {
+  async voteAnswerDown(questionId: number, id: number): Promise<Answer> {
     if (!id || !questionId) {
       throw new QetaError('Invalid id provided', undefined);
     }
@@ -403,7 +397,7 @@ export class QetaClient implements QetaApi {
   async updateQuestion(
     id: string,
     question: QuestionRequest,
-  ): Promise<QuestionResponse> {
+  ): Promise<Question> {
     const response = await this.fetchApi.fetch(
       `${await this.getBaseUrl()}/questions/${id}`,
       {