yuuza/outline
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Move collection description rendering to JSON (#6944)

Browse Source 
* First pass, moving collection description rendering to JSON

* tsc

* docs

* refactor

* test
This commit is contained in:
Tom Moor
2024-05-25 18:17:19 -04:00
committed by GitHub
parent d51267b8bc
commit f103d73b48
15 changed files with 225 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
server/models/helpers/DocumentHelper.tsx
View File

@@ -11,7 +11,7 @@ import { ProsemirrorData } from "@shared/types";
import { parser, serializer, schema } from "@server/editor";
import { addTags } from "@server/logging/tracer";
import { trace } from "@server/logging/tracing";
import { Document, Revision } from "@server/models";
import { Collection, Document, Revision } from "@server/models";
import diff from "@server/utils/diff";
import { ProsemirrorHelper } from "./ProsemirrorHelper";
import { TextHelper } from "./TextHelper";
@@ -43,7 +43,7 @@ export class DocumentHelper {
* @param document The document or revision to convert
* @returns The document content as a Prosemirror Node
*/
static toProsemirror(document: Document | Revision) {
static toProsemirror(document: Document | Revision | Collection) {
if ("content" in document && document.content) {
return Node.fromJSON(schema, document.content);
}
@@ -52,7 +52,10 @@ export class DocumentHelper {
Y.applyUpdate(ydoc, document.state);
return Node.fromJSON(schema, yDocToProsemirrorJSON(ydoc, "default"));
}
return parser.parse(document.text) || Node.fromJSON(schema, {});
const text =
document instanceof Collection ? document.description : document.text;
return parser.parse(text ?? "") || Node.fromJSON(schema, {});
}
/**
@@ -64,7 +67,7 @@ export class DocumentHelper {
* @returns The document content as a plain JSON object
*/
static async toJSON(
document: Document | Revision,
document: Document | Revision | Collection,
options?: {
/** The team context */
teamId: string;
@@ -83,6 +86,8 @@ export class DocumentHelper {
const ydoc = new Y.Doc();
Y.applyUpdate(ydoc, document.state);
doc = Node.fromJSON(schema, yDocToProsemirrorJSON(ydoc, "default"));
} else if (document instanceof Collection) {
doc = parser.parse(document.description ?? "");
} else {
doc = parser.parse(document.text);
}
@@ -123,12 +128,12 @@ export class DocumentHelper {
}
/**
* Returns the document as Markdown. This is a lossy conversion and should nly be used for export.
* Returns the document as Markdown. This is a lossy conversion and should only be used for export.
*
* @param document The document or revision to convert
* @returns The document title and content as a Markdown string
*/
static toMarkdown(document: Document | Revision) {
static toMarkdown(document: Document | Revision | Collection) {
const text = serializer
.serialize(DocumentHelper.toProsemirror(document))
.replace(/\n\\(\n|$)/g, "\n\n")
@@ -138,6 +143,10 @@ export class DocumentHelper {
.replace(/’/g, "'")
.trim();
if (document instanceof Collection) {
return text;
}
const title = `${document.emoji ? document.emoji + " " : ""}${
document.title
}`;