mirror of
https://github.com/outline/outline.git
synced 2026-11-20 21:23:06 +03:00
* feat: Show export completion in the notifications center Exports now create an in-app notification with the export name, status, format and a download button. Export emails are sent from the notification with a one-minute delay, so they are skipped once the notification is read. * fix: Avoid nested button in export notification and keep it after delete * fix: Revoke export notifications when access to the source is lost * fix: Remove icon from export notification download cue
147 lines
3.4 KiB
TypeScript
147 lines
3.4 KiB
TypeScript
import { computed, observable } from "mobx";
|
|
import { t } from "i18next";
|
|
import { toast } from "sonner";
|
|
import {
|
|
FileOperationFormat,
|
|
FileOperationState,
|
|
FileOperationType,
|
|
} from "@shared/types";
|
|
import { bytesToHumanReadable } from "@shared/utils/files";
|
|
import type FileOperationsStore from "~/stores/FileOperationsStore";
|
|
import User from "./User";
|
|
import Model from "./base/Model";
|
|
import { AfterChange } from "./decorators/Lifecycle";
|
|
import Relation from "./decorators/Relation";
|
|
|
|
class FileOperation extends Model {
|
|
static modelName = "FileOperation";
|
|
|
|
/** Readable labels for each file operation format. */
|
|
static formatLabels: Record<FileOperationFormat, string> = {
|
|
[FileOperationFormat.JSON]: "JSON",
|
|
[FileOperationFormat.Notion]: "Notion",
|
|
[FileOperationFormat.MarkdownZip]: "Markdown",
|
|
[FileOperationFormat.OKFZip]: "OKF",
|
|
[FileOperationFormat.HTMLZip]: "HTML",
|
|
[FileOperationFormat.TextBundleZip]: "TextBundle",
|
|
[FileOperationFormat.PDF]: "PDF",
|
|
};
|
|
|
|
constructor(fields: Record<string, unknown>, store: FileOperationsStore) {
|
|
super(fields, store);
|
|
this.initialize(fields);
|
|
}
|
|
|
|
store: FileOperationsStore;
|
|
|
|
@observable
|
|
state: FileOperationState;
|
|
|
|
name: string;
|
|
|
|
error: string | null;
|
|
|
|
collectionId: string | null;
|
|
|
|
documentId: string | null;
|
|
|
|
@observable
|
|
size: number;
|
|
|
|
type: FileOperationType;
|
|
|
|
format: FileOperationFormat;
|
|
|
|
@Relation(() => User)
|
|
user: User;
|
|
|
|
@computed
|
|
get sizeInMB(): string {
|
|
return bytesToHumanReadable(this.size);
|
|
}
|
|
|
|
/**
|
|
* The name to show for the file operation. Exports without a collection or
|
|
* document cover all collections.
|
|
*/
|
|
get displayName(): string {
|
|
if (
|
|
this.type === FileOperationType.Export &&
|
|
!this.collectionId &&
|
|
!this.documentId
|
|
) {
|
|
return t("All collections");
|
|
}
|
|
return this.name;
|
|
}
|
|
|
|
/**
|
|
* A readable label for the format of the file operation.
|
|
*/
|
|
@computed
|
|
get formatLabel(): string {
|
|
return FileOperation.formatLabels[this.format];
|
|
}
|
|
|
|
@computed
|
|
get downloadUrl(): string {
|
|
return `/api/fileOperations.redirect?id=${this.id}`;
|
|
}
|
|
|
|
// Hooks
|
|
|
|
@AfterChange
|
|
static handleExportToast(
|
|
model: FileOperation,
|
|
previousAttributes: Partial<FileOperation>
|
|
) {
|
|
if (model.type !== FileOperationType.Export) {
|
|
return;
|
|
}
|
|
|
|
const { ui, auth, notifications } = model.store.rootStore;
|
|
if (model.user?.id !== auth.user?.id) {
|
|
return;
|
|
}
|
|
|
|
const tracked = ui.exportToasts.get(model.id);
|
|
if (!tracked) {
|
|
return;
|
|
}
|
|
|
|
if (
|
|
previousAttributes.state !== model.state &&
|
|
model.state === FileOperationState.Complete
|
|
) {
|
|
toast.success(t("Export complete"), {
|
|
id: tracked.toastId,
|
|
description: model.name,
|
|
duration: Infinity,
|
|
action: {
|
|
label: t("Download"),
|
|
onClick: () => {
|
|
window.open(model.downloadUrl, "_blank");
|
|
void notifications
|
|
.find({ fileOperationId: model.id })
|
|
?.markAsRead();
|
|
},
|
|
},
|
|
});
|
|
ui.removeExportToast(model.id);
|
|
}
|
|
|
|
if (
|
|
previousAttributes.state !== model.state &&
|
|
model.state === FileOperationState.Error
|
|
) {
|
|
toast.error(t("Export failed"), {
|
|
id: tracked.toastId,
|
|
description: model.error || t("An unexpected error occurred"),
|
|
});
|
|
ui.removeExportToast(model.id);
|
|
}
|
|
}
|
|
}
|
|
|
|
export default FileOperation;
|