mirror of
https://github.com/hedgedoc/hedgedoc.git
synced 2025-05-14 15:14:56 -04:00

This was done to give better typings to the function signatures of entities `create` methods. It also ensures that each field that should be set to `null` is set to `null` and doesn't leave that up to the typeorm handlers. See: #1641 Signed-off-by: Philip Molares <philip.molares@udo.edu>
86 lines
1.7 KiB
TypeScript
86 lines
1.7 KiB
TypeScript
/*
|
|
* SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file)
|
|
*
|
|
* SPDX-License-Identifier: AGPL-3.0-only
|
|
*/
|
|
import {
|
|
Column,
|
|
CreateDateColumn,
|
|
Entity,
|
|
JoinTable,
|
|
ManyToMany,
|
|
ManyToOne,
|
|
PrimaryGeneratedColumn,
|
|
} from 'typeorm';
|
|
|
|
import { Note } from '../notes/note.entity';
|
|
import { Edit } from './edit.entity';
|
|
|
|
/**
|
|
* The state of a note at a particular point in time,
|
|
* with the content at that time and the diff to the previous revision.
|
|
*
|
|
*/
|
|
@Entity()
|
|
export class Revision {
|
|
@PrimaryGeneratedColumn()
|
|
id: number;
|
|
|
|
/**
|
|
* The patch from the previous revision to this one.
|
|
*/
|
|
@Column({
|
|
type: 'text',
|
|
})
|
|
patch: string;
|
|
|
|
/**
|
|
* The note content at this revision.
|
|
*/
|
|
@Column({
|
|
type: 'text',
|
|
})
|
|
content: string;
|
|
|
|
/**
|
|
* The length of the note content.
|
|
*/
|
|
@Column()
|
|
length: number;
|
|
|
|
/**
|
|
* Date at which the revision was created.
|
|
*/
|
|
@CreateDateColumn()
|
|
createdAt: Date;
|
|
|
|
/**
|
|
* Note this revision belongs to.
|
|
*/
|
|
@ManyToOne((_) => Note, (note) => note.revisions, { onDelete: 'CASCADE' })
|
|
note: Note;
|
|
|
|
/**
|
|
* All edit objects which are used in the revision.
|
|
*/
|
|
@ManyToMany((_) => Edit, (edit) => edit.revisions)
|
|
@JoinTable()
|
|
edits: Edit[];
|
|
|
|
// eslint-disable-next-line @typescript-eslint/no-empty-function
|
|
private constructor() {}
|
|
|
|
static create(
|
|
content: string,
|
|
patch: string,
|
|
note: Note,
|
|
): Omit<Revision, 'id' | 'createdAt'> {
|
|
const newRevision = new Revision();
|
|
newRevision.patch = patch;
|
|
newRevision.content = content;
|
|
newRevision.length = content.length;
|
|
newRevision.note = note;
|
|
newRevision.edits = [];
|
|
return newRevision;
|
|
}
|
|
}
|