Merge pull request #742 from JiscSD/OC-978

OC-978: Add new flag categories
JiscSD · Dec 18, 2024 · 06c5714 · 06c5714
2 parents a61d225 + 5a5d247
commit 06c5714
Show file tree

Hide file tree

Showing 7 changed files with 48 additions and 18 deletions.
diff --git a/api/prisma/migrations/20241217135037_add_flag_categories/migration.sql b/api/prisma/migrations/20241217135037_add_flag_categories/migration.sql
@@ -0,0 +1,11 @@
+-- AlterEnum
+-- This migration adds more than one value to an enum.
+-- With PostgreSQL versions 11 and earlier, this is not possible
+-- in a single migration. This can be worked around by creating
+-- multiple migrations, each migration adding only one value to
+-- the enum.
+
+
+ALTER TYPE "PublicationFlagCategoryEnum" ADD VALUE 'UNDECLARED_AI';
+ALTER TYPE "PublicationFlagCategoryEnum" ADD VALUE 'NOT_IN_OCTOPUS_FORMAT';
+ALTER TYPE "PublicationFlagCategoryEnum" ADD VALUE 'IRRELEVANT_LINKED_PUBLICATION';
diff --git a/api/prisma/schema.prisma b/api/prisma/schema.prisma
@@ -354,6 +354,9 @@ enum PublicationFlagCategoryEnum {
     UNDECLARED_IMAGE_MANIPULATION
     COPYRIGHT
     INAPPROPRIATE
+    UNDECLARED_AI
+    NOT_IN_OCTOPUS_FORMAT
+    IRRELEVANT_LINKED_PUBLICATION
 }
 
 enum LicenceType {

diff --git a/api/src/components/flag/controller.ts b/api/src/components/flag/controller.ts
@@ -1,12 +1,13 @@
 import * as cheerio from 'cheerio';
 import nodemailer from 'nodemailer';
+
+import * as email from 'lib/email';
+import * as flagService from 'flag/service';
 import * as Helpers from 'lib/helpers';
-import * as response from 'lib/response';
+import * as I from 'interface';
 import * as publicationService from 'publication/service';
-import * as flagService from 'flag/service';
+import * as response from 'lib/response';
 import * as userService from 'user/service';
-import * as I from 'interface';
-import * as email from 'lib/email';
 
 export const get = async (event: I.APIRequest<undefined, undefined, I.GetFlagByID>): Promise<I.JSONResponse> => {
     try {
@@ -48,14 +49,19 @@ export const getUserFlags = async (
     }
 };
 
-const formatFlagType = (flagType: I.FlagCategory): string => {
-    const types = {
+const formatFlagType = (flagType: I.PublicationFlagCategoryEnum): string => {
+    const types: {
+        [key in I.PublicationFlagCategoryEnum]: string;
+    } = {
         PLAGIARISM: 'Plagiarism',
         ETHICAL_ISSUES: 'Ethical issues',
         MISREPRESENTATION: 'Misrepresentation',
         UNDECLARED_IMAGE_MANIPULATION: 'Undeclared image manipulation',
         COPYRIGHT: 'Copyright',
-        INAPPROPRIATE: 'Inappropriate'
+        INAPPROPRIATE: 'Inappropriate',
+        UNDECLARED_AI: 'Undeclared use of generative AI',
+        NOT_IN_OCTOPUS_FORMAT: 'Not in Octopus format',
+        IRRELEVANT_LINKED_PUBLICATION: 'Linked to irrelevant publication'
     };
 
     return types[flagType];

diff --git a/api/src/components/flag/schema/createFlag.ts b/api/src/components/flag/schema/createFlag.ts
@@ -5,13 +5,16 @@ const updatedPublicationSchema: I.Schema = {
     properties: {
         category: {
             type: 'string',
-            enum: <I.FlagCategory[]>[
+            enum: <I.PublicationFlagCategoryEnum[]>[
                 'PLAGIARISM',
                 'ETHICAL_ISSUES',
                 'MISREPRESENTATION',
                 'UNDECLARED_IMAGE_MANIPULATION',
                 'COPYRIGHT',
-                'INAPPROPRIATE'
+                'INAPPROPRIATE',
+                'UNDECLARED_AI',
+                'NOT_IN_OCTOPUS_FORMAT',
+                'IRRELEVANT_LINKED_PUBLICATION'
             ]
         },
         comment: {

diff --git a/api/src/lib/interface.ts b/api/src/lib/interface.ts
@@ -349,14 +349,6 @@ export interface ConfirmVerificationCodeBody {
 const prismaGeneratedFlagType = Prisma.validator<Prisma.PublicationFlagsDefaultArgs>()({});
 export type Flag = Prisma.PublicationFlagsGetPayload<typeof prismaGeneratedFlagType>;
 
-export type FlagCategory =
-    | 'PLAGIARISM'
-    | 'ETHICAL_ISSUES'
-    | 'MISREPRESENTATION'
-    | 'UNDECLARED_IMAGE_MANIPULATION'
-    | 'COPYRIGHT'
-    | 'INAPPROPRIATE';
-
 export interface CreateFlagPathParams {
     publicationId: string;
 }

diff --git a/ui/src/config/values.ts b/ui/src/config/values.ts
@@ -856,6 +856,18 @@ export const octopusInformation: Interfaces.OctopusInformation = {
         INAPPROPRIATE: {
             value: 'INAPPROPRIATE',
             nicename: 'Inappropriate'
+        },
+        UNDECLARED_AI: {
+            value: 'UNDECLARED_AI',
+            nicename: 'Undeclared use of generative AI'
+        },
+        NOT_IN_OCTOPUS_FORMAT: {
+            value: 'NOT_IN_OCTOPUS_FORMAT',
+            nicename: 'Not in Octopus format'
+        },
+        IRRELEVANT_LINKED_PUBLICATION: {
+            value: 'IRRELEVANT_LINKED_PUBLICATION',
+            nicename: 'Linked to irrelevant publication'
         }
     }
 };

diff --git a/ui/src/lib/types.ts b/ui/src/lib/types.ts
@@ -112,7 +112,10 @@ export type RedFlagTypes =
     | 'MISREPRESENTATION'
     | 'UNDECLARED_IMAGE_MANIPULATION'
     | 'COPYRIGHT'
-    | 'INAPPROPRIATE';
+    | 'INAPPROPRIATE'
+    | 'UNDECLARED_AI'
+    | 'NOT_IN_OCTOPUS_FORMAT'
+    | 'IRRELEVANT_LINKED_PUBLICATION';
 
 export type Languages =
     | 'ab'