feat: When exporting a Super note, embedded files can be inlined in the note or exported along the note in a zip file. You can now also choose to include frontmatter when exporting to Markdown format.
(#2610)
This commit is contained in:
Aman Harwara
@@ -1,6 +1,8 @@
|
||||
import { WebApplication } from '@/Application/WebApplication'
|
||||
import { HeadlessSuperConverter } from '@/Components/SuperEditor/Tools/HeadlessSuperConverter'
|
||||
import { NoteType, PrefKey, SNNote, PrefDefaults } from '@standardnotes/snjs'
|
||||
import { WebApplicationInterface } from '@standardnotes/ui-services'
|
||||
import { NoteType, PrefKey, SNNote, PrefDefaults, FileItem, PrefValue, pluralize } from '@standardnotes/snjs'
|
||||
import { WebApplicationInterface, parseAndCreateZippableFileName, sanitizeFileName } from '@standardnotes/ui-services'
|
||||
import { ZipDirectoryEntry } from '@zip.js/zip.js'
|
||||
|
||||
export const getNoteFormat = (application: WebApplicationInterface, note: SNNote) => {
|
||||
if (note.noteType === NoteType.Super) {
|
||||
@@ -21,7 +23,49 @@ export const getNoteFileName = (application: WebApplicationInterface, note: SNNo
|
||||
return `${note.title}.${format}`
|
||||
}
|
||||
|
||||
export const getNoteBlob = (application: WebApplicationInterface, note: SNNote) => {
|
||||
const headlessSuperConverter = new HeadlessSuperConverter()
|
||||
|
||||
// @ts-expect-error Using inline loaders to load CSS as string
|
||||
import superEditorCSS from '!css-loader!sass-loader!../Components/SuperEditor/Lexical/Theme/editor.scss'
|
||||
// @ts-expect-error Using inline loaders to load CSS as string
|
||||
import snColorsCSS from '!css-loader!sass-loader!@standardnotes/styles/src/Styles/_colors.scss'
|
||||
// @ts-expect-error Using inline loaders to load CSS as string
|
||||
import exportOverridesCSS from '!css-loader!sass-loader!../Components/SuperEditor/Lexical/Theme/export-overrides.scss'
|
||||
import { getBase64FromBlob } from './Utils'
|
||||
import { ToastType, addToast, dismissToast } from '@standardnotes/toast'
|
||||
|
||||
const superHTML = (note: SNNote, content: string) => `<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<title>${note.title}</title>
|
||||
<style>
|
||||
${snColorsCSS.toString()}
|
||||
${superEditorCSS.toString()}
|
||||
${exportOverridesCSS.toString()}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
${content}
|
||||
</body>
|
||||
</html>
|
||||
`
|
||||
|
||||
const superMarkdown = (note: SNNote, content: string) => `---
|
||||
title: ${note.title}
|
||||
created_at: ${note.created_at.toISOString()}
|
||||
updated_at: ${note.serverUpdatedAt.toISOString()}
|
||||
uuid: ${note.uuid}
|
||||
---
|
||||
|
||||
${content}
|
||||
`
|
||||
|
||||
export const getNoteBlob = async (
|
||||
application: WebApplication,
|
||||
note: SNNote,
|
||||
superEmbedBehavior: PrefValue[PrefKey.SuperNoteExportEmbedBehavior],
|
||||
) => {
|
||||
const format = getNoteFormat(application, note)
|
||||
let type: string
|
||||
switch (format) {
|
||||
@@ -38,12 +82,162 @@ export const getNoteBlob = (application: WebApplicationInterface, note: SNNote)
|
||||
type = 'text/plain'
|
||||
break
|
||||
}
|
||||
const content =
|
||||
note.noteType === NoteType.Super
|
||||
? new HeadlessSuperConverter().convertSuperStringToOtherFormat(note.text, format)
|
||||
: note.text
|
||||
const blob = new Blob([content], {
|
||||
if (note.noteType === NoteType.Super) {
|
||||
const content = await headlessSuperConverter.convertSuperStringToOtherFormat(note.text, format, {
|
||||
embedBehavior: superEmbedBehavior,
|
||||
getFileItem: (id) => application.items.findItem<FileItem>(id),
|
||||
getFileBase64: async (id) => {
|
||||
const fileItem = application.items.findItem<FileItem>(id)
|
||||
if (!fileItem) {
|
||||
return
|
||||
}
|
||||
const fileBlob = await application.filesController.getFileBlob(fileItem)
|
||||
if (!fileBlob) {
|
||||
return
|
||||
}
|
||||
return await getBase64FromBlob(fileBlob)
|
||||
},
|
||||
})
|
||||
const useMDFrontmatter =
|
||||
format === 'md' &&
|
||||
application.getPreference(
|
||||
PrefKey.SuperNoteExportUseMDFrontmatter,
|
||||
PrefDefaults[PrefKey.SuperNoteExportUseMDFrontmatter],
|
||||
)
|
||||
const result =
|
||||
format === 'html' ? superHTML(note, content) : useMDFrontmatter ? superMarkdown(note, content) : content
|
||||
const blob = new Blob([result], {
|
||||
type,
|
||||
})
|
||||
return blob
|
||||
}
|
||||
const blob = new Blob([note.text], {
|
||||
type,
|
||||
})
|
||||
return blob
|
||||
}
|
||||
|
||||
const isSuperNote = (note: SNNote) => {
|
||||
return note.noteType === NoteType.Super
|
||||
}
|
||||
|
||||
const noteHasEmbeddedFiles = (note: SNNote) => {
|
||||
return note.text.includes('"type":"snfile"')
|
||||
}
|
||||
|
||||
const noteRequiresFolder = (
|
||||
note: SNNote,
|
||||
superExportFormat: PrefValue[PrefKey.SuperNoteExportFormat],
|
||||
superEmbedBehavior: PrefValue[PrefKey.SuperNoteExportEmbedBehavior],
|
||||
) => {
|
||||
if (!isSuperNote(note)) {
|
||||
return false
|
||||
}
|
||||
if (superExportFormat === 'json') {
|
||||
return false
|
||||
}
|
||||
if (superEmbedBehavior !== 'separate') {
|
||||
return false
|
||||
}
|
||||
return noteHasEmbeddedFiles(note)
|
||||
}
|
||||
|
||||
const addEmbeddedFilesToFolder = async (application: WebApplication, note: SNNote, folder: ZipDirectoryEntry) => {
|
||||
try {
|
||||
const embeddedFileIDs = headlessSuperConverter.getEmbeddedFileIDsFromSuperString(note.text)
|
||||
for (const embeddedFileID of embeddedFileIDs) {
|
||||
const fileItem = application.items.findItem<FileItem>(embeddedFileID)
|
||||
if (!fileItem) {
|
||||
continue
|
||||
}
|
||||
const embeddedFileBlob = await application.filesController.getFileBlob(fileItem)
|
||||
if (!embeddedFileBlob) {
|
||||
continue
|
||||
}
|
||||
folder.addBlob(parseAndCreateZippableFileName(fileItem.title), embeddedFileBlob)
|
||||
}
|
||||
} catch (error) {
|
||||
console.error(error)
|
||||
}
|
||||
}
|
||||
|
||||
export const createNoteExport = async (
|
||||
application: WebApplication,
|
||||
notes: SNNote[],
|
||||
): Promise<
|
||||
| {
|
||||
blob: Blob
|
||||
fileName: string
|
||||
}
|
||||
| undefined
|
||||
> => {
|
||||
if (notes.length === 0) {
|
||||
return
|
||||
}
|
||||
|
||||
const toast = addToast({
|
||||
type: ToastType.Progress,
|
||||
message: `Exporting ${notes.length} ${pluralize(notes.length, 'note', 'notes')}...`,
|
||||
})
|
||||
|
||||
const superExportFormatPref = application.getPreference(
|
||||
PrefKey.SuperNoteExportFormat,
|
||||
PrefDefaults[PrefKey.SuperNoteExportFormat],
|
||||
)
|
||||
const superEmbedBehaviorPref = application.getPreference(
|
||||
PrefKey.SuperNoteExportEmbedBehavior,
|
||||
PrefDefaults[PrefKey.SuperNoteExportEmbedBehavior],
|
||||
)
|
||||
|
||||
if (notes.length === 1 && !noteRequiresFolder(notes[0], superExportFormatPref, superEmbedBehaviorPref)) {
|
||||
const blob = await getNoteBlob(application, notes[0], superEmbedBehaviorPref)
|
||||
const fileName = getNoteFileName(application, notes[0])
|
||||
dismissToast(toast)
|
||||
return {
|
||||
blob,
|
||||
fileName,
|
||||
}
|
||||
}
|
||||
|
||||
const zip = await import('@zip.js/zip.js')
|
||||
const zipFS = new zip.fs.FS()
|
||||
const { root } = zipFS
|
||||
|
||||
if (notes.length === 1 && noteRequiresFolder(notes[0], superExportFormatPref, superEmbedBehaviorPref)) {
|
||||
const blob = await getNoteBlob(application, notes[0], superEmbedBehaviorPref)
|
||||
const fileName = parseAndCreateZippableFileName(getNoteFileName(application, notes[0]))
|
||||
root.addBlob(fileName, blob)
|
||||
|
||||
await addEmbeddedFilesToFolder(application, notes[0], root)
|
||||
|
||||
const zippedBlob = await zipFS.exportBlob()
|
||||
dismissToast(toast)
|
||||
return {
|
||||
blob: zippedBlob,
|
||||
fileName: fileName + '.zip',
|
||||
}
|
||||
}
|
||||
|
||||
for (const note of notes) {
|
||||
const blob = await getNoteBlob(application, note, superEmbedBehaviorPref)
|
||||
const fileName = parseAndCreateZippableFileName(getNoteFileName(application, note))
|
||||
|
||||
if (!noteRequiresFolder(note, superExportFormatPref, superEmbedBehaviorPref)) {
|
||||
root.addBlob(fileName, blob)
|
||||
continue
|
||||
}
|
||||
|
||||
const folder = root.addDirectory(sanitizeFileName(note.title))
|
||||
folder.addBlob(fileName, blob)
|
||||
await addEmbeddedFilesToFolder(application, note, folder)
|
||||
}
|
||||
|
||||
const zippedBlob = await zipFS.exportBlob()
|
||||
|
||||
dismissToast(toast)
|
||||
|
||||
return {
|
||||
blob: zippedBlob,
|
||||
fileName: `Standard Notes Export - ${application.archiveService.formattedDateForExports()}.zip`,
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user