Feat(contact-tagging): Add support tagable contacts with bulk action

apps/backend/README.md

@@ -109,8 +109,8 @@ changes
 
 ```bash
 docker compose -f ../../docker-compose.yml start db
-docker compose -f ../../docker-compose.yml run app yarn typeorm migration:generate src/migrations/MigrationName && yarn format
-yarn build
+docker compose -f ../../docker-compose.yml run app yarn typeorm migration:generate /opt/packages/core/src/migrations/MigrationName && yarn format
+yarn build # necessary for the new migration files to be found
 docker compose -f ../../docker-compose.yml run app yarn typeorm migration:run
 ```
 
@@ -168,14 +168,6 @@ Various tools for administration, including nightly cron jobs
 ./src/tools
 ```
 
-- **Database migrations**
-
-Autogenerated by TypeORM
-
-```
-./src/migrations
-```
-
 #### 📡 Webhooks
 
 Webhooks are handled by the `webhook_app` service. This is a separate service from the API to allow for scaling independently.

apps/backend/src/api/app.ts

@@ -126,6 +126,7 @@ initApp()
           log.notice("Bad request, probably a validation error", {
             body: req.body,
             query: req.query,
+            stack: error.stack,
             error
           });
         }

apps/backend/src/api/controllers/CalloutController.ts

@@ -254,7 +254,7 @@ export class CalloutController {
     @CurrentAuth({ required: true }) auth: AuthInfo,
     @CalloutId() id: string,
     @Param("tagId") tagId: string,
-    @PartialBody() data: CreateCalloutTagDto // Partial<CreateCalloutTagData>
+    @PartialBody() data: CreateCalloutTagDto // Partial<TagCreateData>
   ): Promise<GetCalloutTagDto | undefined> {
     await getRepository(CalloutTag).update({ id: tagId, calloutId: id }, data);
 

apps/backend/src/api/controllers/ContactController.ts

@@ -1,8 +1,5 @@
-import {
-  ContributionPeriod,
-  NewsletterStatus,
-  GetContactWith
-} from "@beabee/beabee-common";
+import { ContributionPeriod, GetContactWith } from "@beabee/beabee-common";
+import { getRepository } from "@beabee/core/database";
 import { plainToInstance } from "class-transformer";
 import { Response } from "express";
 import {
@@ -23,14 +20,13 @@ import {
 } from "routing-controllers";
 
 import ContactsService from "@beabee/core/services/ContactsService";
-import OptionsService from "@beabee/core/services/OptionsService";
 import PaymentFlowService from "@beabee/core/services/PaymentFlowService";
 import PaymentService from "@beabee/core/services/PaymentService";
 import ContactMfaService from "@beabee/core/services/ContactMfaService";
 
 import { generatePassword } from "@beabee/core/utils/auth";
 
-import { Contact, JoinFlow } from "@beabee/core/models";
+import { Contact, JoinFlow, ContactTag } from "@beabee/core/models";
 
 import { GetExportQuery } from "@api/dto/BaseDto";
 import {
@@ -41,6 +37,7 @@ import {
   ListContactsDto,
   UpdateContactDto
 } from "@api/dto/ContactDto";
+import { CreateContactTagDto, GetContactTagDto } from "@api/dto/ContactTagDto";
 import {
   CreateContactMfaDto,
   DeleteContactMfaDto,
@@ -75,6 +72,7 @@ import ContactExporter from "@api/transformers/ContactExporter";
 import ContactTransformer from "@api/transformers/ContactTransformer";
 import ContactRoleTransformer from "@api/transformers/ContactRoleTransformer";
 import PaymentTransformer from "@api/transformers/PaymentTransformer";
+import ContactTagTransformer from "@api/transformers/ContactTagTransformer";
 
 import { AuthInfo } from "@type/auth-info";
 
@@ -145,6 +143,35 @@ export class ContactController {
     return res;
   }
 
+  @Authorized("admin")
+  @Get("/tags")
+  async getAllContactTags(
+    @CurrentAuth({ required: true }) auth: AuthInfo
+  ): Promise<GetContactTagDto[]> {
+    const result = await ContactTagTransformer.fetch(auth, {
+      limit: -1,
+      rules: {
+        condition: "AND",
+        rules: []
+      }
+    });
+
+    return result.items;
+  }
+
+  @Authorized("admin")
+  @Post("/tags")
+  async createGlobalContactTag(
+    @Body() data: CreateContactTagDto
+  ): Promise<GetContactTagDto> {
+    const tag = await getRepository(ContactTag).save({
+      name: data.name,
+      description: data.description
+    });
+
+    return ContactTagTransformer.convert(tag);
+  }
+
   @Get("/:id")
   async getContact(
     @CurrentAuth({ required: true }) auth: AuthInfo,
@@ -174,7 +201,7 @@ export class ContactController {
     if (data.profile) {
       if (
         !auth.roles.includes("admin") &&
-        (data.profile.tags || data.profile.notes || data.profile.description)
+        (data.profile.notes || data.profile.description)
       ) {
         throw new UnauthorizedError();
       }

apps/backend/src/api/dto/ContactDto.ts

@@ -33,6 +33,7 @@ import {
   CreateContactRoleDto,
   GetContactRoleDto
 } from "@api/dto/ContactRoleDto";
+import { GetContactTagDto } from "@api/dto/ContactTagDto";
 import { ForceUpdateContributionDto } from "@api/dto/ContributionDto";
 
 import IsPassword from "@api/validators/IsPassword";
@@ -157,6 +158,10 @@ export class GetContactDto extends BaseContactDto {
   @IsOptional()
   @ValidateNested()
   roles?: GetContactRoleDto[];
+
+  @IsOptional()
+  @ValidateNested({ each: true })
+  tags?: GetContactTagDto[];
 }
 
 export class UpdateContactDto extends BaseContactDto {
@@ -180,6 +185,10 @@ export class CreateContactDto extends UpdateContactDto {
   @ValidateNested({ each: true })
   @Type(() => CreateContactRoleDto)
   roles?: CreateContactRoleDto[];
+
+  @IsOptional()
+  @IsString({ each: true })
+  tags?: string[];
 }
 
 export interface ExportContactDto {

apps/backend/src/api/dto/ContactProfileDto.ts

@@ -77,11 +77,6 @@ export class UpdateContactProfileDto implements Partial<GetContactProfileDto> {
   newsletterGroups?: string[];
 
   // Admin only
-
-  @IsOptional()
-  @IsString({ each: true })
-  tags?: string[];
-
   @IsOptional()
   @IsString()
   notes?: string;

apps/backend/src/api/dto/ContactTagDto.ts

@@ -0,0 +1,24 @@
+import { IsIn, IsString, IsUUID } from "class-validator";
+
+import { GetPaginatedQuery } from "@api/dto/BaseDto";
+
+export class GetContactTagDto {
+  @IsUUID()
+  id!: string;
+
+  @IsString()
+  name!: string;
+}
+
+export class CreateContactTagDto {
+  @IsString()
+  name!: string;
+
+  @IsString()
+  description!: string;
+}
+
+export class ListContactTagsDto extends GetPaginatedQuery {
+  @IsIn(["id", "name"])
+  sort?: string;
+}

apps/backend/src/api/dto/index.ts

@@ -11,6 +11,7 @@ export * from "./ContactDto.js";
 export * from "./ContactMfaDto.js";
 export * from "./ContactProfileDto.js";
 export * from "./ContactRoleDto.js";
+export * from "./ContactTagDto.js";
 export * from "./ContentDto.js";
 export * from "./ContentTelegramDto.js";
 export * from "./ContributionDto.js";

apps/backend/src/api/transformers/ContactProfileTransformer.ts

@@ -32,7 +32,6 @@ class ContactProfileTransformer extends BaseTransformer<
       newsletterStatus: profile.newsletterStatus,
       newsletterGroups: profile.newsletterGroups,
       ...(auth?.roles.includes("admin") && {
-        tags: profile.tags,
         notes: profile.notes,
         description: profile.description
       })

apps/backend/src/api/transformers/ContactTagTransformer.ts

@@ -0,0 +1,30 @@
+import { ContactTag } from "@beabee/core/models";
+import { GetContactTagDto } from "@api/dto/ContactTagDto";
+import { BaseTransformer } from "./BaseTransformer";
+import {
+  ContactTagFilterName,
+  contactTagFilters,
+  RoleType
+} from "@beabee/beabee-common";
+import { TransformPlainToInstance } from "class-transformer";
+
+class ContactTagTransformer extends BaseTransformer<
+  ContactTag,
+  GetContactTagDto,
+  ContactTagFilterName
+> {
+  protected model = ContactTag;
+  protected filters = contactTagFilters;
+
+  protected allowedRoles: RoleType[] = ["admin"];
+
+  @TransformPlainToInstance(GetContactTagDto)
+  convert(tag: ContactTag): GetContactTagDto {
+    return {
+      id: tag.id,
+      name: tag.name
+    };
+  }
+}
+
+export default new ContactTagTransformer();

apps/backend/src/api/transformers/ContactTransformer.ts

@@ -17,6 +17,7 @@ import ContactProfileTransformer from "@api/transformers/ContactProfileTransform
 import { mergeRules } from "@api/utils/rules";
 
 import { AuthInfo } from "@type/auth-info";
+import ContactTagTransformer from "./ContactTagTransformer";
 
 class ContactTransformer extends BaseContactTransformer<
   GetContactDto,
@@ -57,6 +58,9 @@ class ContactTransformer extends BaseContactTransformer<
       }),
       ...(opts?.with?.includes(GetContactWith.Contribution) && {
         contribution: contact.contributionInfo
+      }),
+      ...(opts?.with?.includes(GetContactWith.Tags) && {
+        tags: contact.tags.map(ContactTagTransformer.convert)
       })
     };
   }
@@ -88,6 +92,12 @@ class ContactTransformer extends BaseContactTransformer<
         qb.innerJoinAndSelect(`${fieldPrefix}profile`, "profile");
       }
 
+      if (query.with?.includes(GetContactWith.Tags)) {
+        qb.leftJoinAndSelect(`${fieldPrefix}tags`, "tags");
+      }
+
+      console.debug("query.with", query.with);
+
       switch (query.sort) {
         // Add member role to allow sorting by membershipStarts and membershipExpires
         case "membershipStarts":

apps/backend/src/api/transformers/index.ts

@@ -13,6 +13,7 @@ export * from "./CalloutVariantTransformer.js";
 export * from "./ContactExporter.js";
 export * from "./ContactProfileTransformer.js";
 export * from "./ContactRoleTransformer.js";
+export * from "./ContactTagTransformer.js";
 export * from "./ContactTransformer.js";
 export * from "./ContentTransformer.js";
 export * from "./NoticeTransformer.js";

apps/frontend/barrelsby.json

@@ -4,5 +4,5 @@
   "verbose": false,
   "delete": true,
   "local": true,
-  "directory": ["./src/type", "./src/enums", "./src/lib"]
+  "directory": ["./src/type", "./src/enums", "./src/lib", "./src/utils/api"]
 }

apps/frontend/locales/de.json

@@ -462,30 +462,24 @@
     "actions": {
       "assignTo": "Zuweisen",
       "moveBucket": "Antwort verschieben",
-      "toggleTag": "Tag hinzufügen / entfernen",
       "viewOnMap": "Auf Karte anzeigen"
     },
     "editMode": "Vorsicht, du befindest dich im Bearbeitungsmodus!",
     "manageFolders": "Ordner bearbeiten",
     "manageReviewers": "Auswerter bearbeiten",
-    "manageTags": "Tags bearbeiten",
     "notifications": {
       "addedAssignee": "\"{assignee}\" zugewiesen",
-      "addedTag": "Tag \"{tag}\" hinzugefügt",
       "movedToBucket": "Verschoben in {bucket}",
-      "removedAssignee": "Nicht mehr \"{assignee}\" zugewiesen",
-      "removedTag": "Tag \"{tag}\" entfernt"
+      "removedAssignee": "Nicht mehr \"{assignee}\" zugewiesen"
     },
     "responseOf": "Antwort {no} von {total} in {bucket}",
     "selectedCount": "{n} Antwort ausgewählt | {n} Antworten ausgewählt"
   },
   "calloutResponsesPage": {
     "moveToBucket": "Nach {bucket} verschieben",
-    "noTags": "Keine Tags",
     "response": "Antwort",
     "responseNo": "Antwort {no}",
     "searchAssignee": "Zugewiesen an...",
-    "searchTag": "Getaggt mit...",
     "showAnswer": "Antwort",
     "showLatestComment": "Letzter Kommentar",
     "showingOf": "Antworten {start} bis {end} von {total} werden angezeigt"
@@ -680,7 +674,8 @@
     "noResults": "Keine Kontakte gefunden",
     "numResults": "{n} Kontakt gefunden | {n} Kontakte gefunden",
     "search": "Kontakte durchsuchen...",
-    "showingOf": "{start} to {end} von {total} Kontakten werden angezeigt."
+    "showingOf": "{start} to {end} von {total} Kontakten werden angezeigt.",
+    "selectedCount": "{n} Kontakt ausgewählt | {n} Kontakte ausgewählt"
   },
   "contribution": {
     "adminCancelDescription": "Wenn du die Mitgliedschaft des Kontakts kündigst, endet sie am Ende des aktuellen Zahlungszyklus am {date}.",
@@ -1382,6 +1377,16 @@
     "description": "Neues Passwort eingeben, um fortzufahren.",
     "title": "Passwort vergeben"
   },
+  "tags": {
+    "manageTags": "Tags bearbeiten",
+    "toggleTag": "Tag hinzufügen / entfernen",
+    "noTags": "Keine Tags",
+    "searchTag": "Getaggt mit...",
+    "notifications": {
+      "addedTag": "Tag \"{tag}\" hinzugefügt",
+      "removedTag": "Tag \"{tag}\" entfernt",
+    }
+  },
   "tagEditor": {
     "add": "Tag hinzufügen",
     "addNewTag": "Tag hinzufügen",