feat: move title and description to revision entity

Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>

backend/src/notes/note.entity.ts

@@ -7,8 +7,6 @@ import {
   Column,
   CreateDateColumn,
   Entity,
-  JoinTable,
-  ManyToMany,
   ManyToOne,
   OneToMany,
   PrimaryGeneratedColumn,
@@ -21,7 +19,6 @@ import { NoteUserPermission } from '../permissions/note-user-permission.entity';
 import { Revision } from '../revisions/revision.entity';
 import { User } from '../users/user.entity';
 import { Alias } from './alias.entity';
-import { Tag } from './tag.entity';
 import { generatePublicId } from './utils';
 
 @Entity()
@@ -74,22 +71,6 @@ export class Note {
   @OneToMany((_) => MediaUpload, (mediaUpload) => mediaUpload.note)
   mediaUploads: Promise<MediaUpload[]>;
 
-  @Column({
-    nullable: true,
-    type: 'text',
-  })
-  description: string | null;
-
-  @Column({
-    nullable: true,
-    type: 'text',
-  })
-  title: string | null;
-
-  @ManyToMany((_) => Tag, (tag) => tag.notes, { eager: true, cascade: true })
-  @JoinTable()
-  tags: Promise<Tag[]>;
-
   @Column({
     default: 2,
   })
@@ -122,9 +103,6 @@ export class Note {
     newNote.revisions = Promise.resolve([]);
     newNote.historyEntries = Promise.resolve([]);
     newNote.mediaUploads = Promise.resolve([]);
-    newNote.description = null;
-    newNote.title = null;
-    newNote.tags = Promise.resolve([]);
     newNote.version = 2;
     return newNote;
   }

backend/src/notes/tag.entity.ts

@@ -5,7 +5,7 @@
  */
 import { Column, Entity, ManyToMany, PrimaryGeneratedColumn } from 'typeorm';
 
-import { Note } from './note.entity';
+import { Revision } from '../revisions/revision.entity';
 
 @Entity()
 export class Tag {
@@ -17,6 +17,6 @@ export class Tag {
   })
   name: string;
 
-  @ManyToMany((_) => Note, (note) => note.tags)
+  @ManyToMany((_) => Revision, (revision) => revision.tags)
-  notes: Promise<Note[]>;
+  revisions: Promise<Revision[]>;
 }

backend/src/revisions/revision-metadata.dto.ts

@@ -5,7 +5,7 @@
  */
 import { ApiProperty } from '@nestjs/swagger';
 import { Type } from 'class-transformer';
-import { IsDate, IsNumber, IsString } from 'class-validator';
+import { IsArray, IsDate, IsNumber, IsString } from 'class-validator';
 
 import { BaseDto } from '../utils/base.dto.';
 import { Revision } from './revision.entity';
@@ -50,4 +50,31 @@ export class RevisionMetadataDto extends BaseDto {
   @IsNumber()
   @ApiProperty()
   anonymousAuthorCount: number;
+
+  /**
+   * Title of the note
+   * Does not contain any markup but might be empty
+   * @example "Shopping List"
+   */
+  @IsString()
+  @ApiProperty()
+  title: string;
+
+  /**
+   * Description of the note
+   * Does not contain any markup but might be empty
+   * @example Everything I want to buy
+   */
+  @IsString()
+  @ApiProperty()
+  description: string;
+
+  /**
+   * List of tags assigned to this note
+   * @example "['shopping', 'personal']
+   */
+  @IsArray()
+  @IsString({ each: true })
+  @ApiProperty()
+  tags: string[];
 }

backend/src/revisions/revision.entity.ts

@@ -14,6 +14,7 @@ import {
 } from 'typeorm';
 
 import { Note } from '../notes/note.entity';
+import { Tag } from '../notes/tag.entity';
 import { Edit } from './edit.entity';
 
 /**
@@ -34,6 +35,23 @@ export class Revision {
   })
   patch: string;
 
+  @Column({
+    type: 'text',
+  })
+  title: string;
+
+  @Column({
+    type: 'text',
+  })
+  description: string;
+
+  @ManyToMany((_) => Tag, (tag) => tag.revisions, {
+    eager: true,
+    cascade: true,
+  })
+  @JoinTable()
+  tags: Promise<Tag[]>;
+
   /**
    * The note content at this revision.
    */
@@ -77,12 +95,18 @@ export class Revision {
     content: string,
     patch: string,
     note: Note,
-    yjsStateVector?: number[],
+    yjsStateVector: number[] | null,
+    title: string,
+    description: string,
+    tags: Tag[],
   ): Omit<Revision, 'id' | 'createdAt'> {
     const newRevision = new Revision();
     newRevision.patch = patch;
     newRevision.content = content;
     newRevision.length = content.length;
+    newRevision.title = title;
+    newRevision.description = description;
+    newRevision.tags = Promise.resolve(tags);
     newRevision.note = Promise.resolve(note);
     newRevision.edits = Promise.resolve([]);
     newRevision.yjsStateVector = yjsStateVector ?? null;

frontend/src/api/revisions/types.ts

@@ -17,4 +17,7 @@ export interface RevisionMetadata {
   length: number
   authorUsernames: string[]
   anonymousAuthorCount: number
+  title: string
+  tags: string[]
+  description: string
 }

frontend/src/pages/api/private/notes/features/revisions/0.ts

@@ -11,6 +11,9 @@ const handler = (req: NextApiRequest, res: NextApiResponse): void => {
   respondToMatchingRequest<RevisionDetails>(HttpMethod.GET, req, res, {
     id: 0,
     createdAt: '2021-12-21T16:59:42.000Z',
+    title: 'Features',
+    description: 'Many features, such wow!',
+    tags: ['hedgedoc', 'demo', 'react'],
     patch: `Index:
 ===================================================================
 ---

frontend/src/pages/api/private/notes/features/revisions/1.ts

@@ -11,6 +11,9 @@ const handler = (req: NextApiRequest, res: NextApiResponse): void => {
   respondToMatchingRequest<RevisionDetails>(HttpMethod.GET, req, res, {
     id: 1,
     createdAt: '2021-12-29T17:54:11.000Z',
+    title: 'Features',
+    description: 'Many more features, such wow!',
+    tags: ['hedgedoc', 'demo', 'react'],
     patch: `Index:
 ===================================================================
 ---

frontend/src/pages/api/private/notes/features/revisions/index.ts

@@ -14,14 +14,20 @@ const handler = (req: NextApiRequest, res: NextApiResponse): void => {
       createdAt: '2021-12-29T17:54:11.000Z',
       length: 2788,
       authorUsernames: [],
-      anonymousAuthorCount: 4
+      anonymousAuthorCount: 4,
+      title: 'Features',
+      description: 'Many features, such wow!',
+      tags: ['hedgedoc', 'demo', 'react']
     },
     {
       id: 0,
       createdAt: '2021-12-21T16:59:42.000Z',
       length: 2782,
       authorUsernames: [],
-      anonymousAuthorCount: 2
+      anonymousAuthorCount: 2,
+      title: 'Features',
+      description: 'Many more features, such wow!',
+      tags: ['hedgedoc', 'demo', 'react']
     }
   ])
 }