From dccd9fcfe95c41fafffb798dbe40edce5a471e5d Mon Sep 17 00:00:00 2001 From: Tom Moor Date: Tue, 13 Oct 2026 07:59:44 -0400 Subject: [PATCH] chore: Rename titleWithDefault to displayTitle (#14063) --- app/actions/definitions/templates.tsx | 2 +- app/actions/definitions/webmcp.ts | 4 ++-- app/actions/sections.ts | 4 ++-- app/components/CommandBar/useRecentDocumentActions.tsx | 2 +- app/components/CommandBar/useSearchIndex.ts | 2 +- app/components/CommandBar/useTemplatesAction.tsx | 2 +- app/components/DialogTitle.tsx | 2 +- app/components/DocumentCard.tsx | 6 +++--- app/components/DocumentChip.tsx | 2 +- app/components/DocumentListItem.tsx | 4 ++-- app/components/Sidebar/components/SharedWithMeLink.tsx | 2 +- app/components/Sidebar/components/StarredLink.tsx | 2 +- .../Sidebar/hooks/useSidebarLabelAndIcon.tsx | 2 +- app/editor/components/BlockMenu.tsx | 7 ++----- app/editor/extensions/PasteHandler.tsx | 4 ++-- app/hooks/useTemplateMenuActions.tsx | 5 +---- app/menus/NewChildDocumentMenu.tsx | 4 ++-- app/models/Document.ts | 2 +- app/models/Template.ts | 4 ++-- app/scenes/Document/components/Document.tsx | 4 ++-- app/scenes/Document/components/Editor.tsx | 4 +--- app/scenes/Document/components/ReferenceListItem.tsx | 2 +- app/scenes/DocumentDelete.tsx | 4 ++-- app/scenes/DocumentPermanentDelete.tsx | 2 +- app/scenes/Search/components/DocumentFilter.tsx | 2 +- app/scenes/Settings/components/TemplatesTable.tsx | 6 +++--- app/stores/UiStore.ts | 2 +- plugins/slack/server/presenters/messageAttachment.ts | 2 +- plugins/slack/server/processors/SlackProcessor.ts | 4 ++-- server/emails/templates/CommentCreatedEmail.tsx | 10 +++++----- server/emails/templates/CommentMentionedEmail.tsx | 8 ++++---- server/emails/templates/CommentResolvedEmail.tsx | 8 ++++---- server/emails/templates/DocumentAccessRequestEmail.tsx | 8 ++++---- server/emails/templates/DocumentMentionedEmail.tsx | 6 +++--- .../templates/DocumentPublishedOrUpdatedEmail.tsx | 10 +++++----- server/emails/templates/DocumentSharedEmail.tsx | 8 ++++---- server/emails/templates/GroupCommentMentionedEmail.tsx | 8 ++++---- .../emails/templates/GroupDocumentMentionedEmail.tsx | 6 +++--- server/models/Document.ts | 2 +- server/models/FileOperation.ts | 2 +- server/models/helpers/OKFHelper.ts | 2 +- server/presenters/fileOperation.ts | 2 +- server/presenters/unfurl.ts | 2 +- server/queues/tasks/ExportDocumentTreeTask.ts | 4 ++-- .../queues/tasks/ShareSubscriptionNotificationsTask.ts | 2 +- server/routes/api/documents/documents.ts | 2 +- server/routes/api/shares/shares.ts | 2 +- server/routes/api/urls/urls.test.ts | 8 ++++---- 48 files changed, 93 insertions(+), 101 deletions(-) diff --git a/app/actions/definitions/templates.tsx b/app/actions/definitions/templates.tsx index 187cec8cac..e88e859a7a 100644 --- a/app/actions/definitions/templates.tsx +++ b/app/actions/definitions/templates.tsx @@ -84,7 +84,7 @@ export const deleteTemplate = dialogActionFactory({ , diff --git a/app/actions/definitions/webmcp.ts b/app/actions/definitions/webmcp.ts index 17ed0d6718..4aa246d825 100644 --- a/app/actions/definitions/webmcp.ts +++ b/app/actions/definitions/webmcp.ts @@ -25,7 +25,7 @@ export const getCurrentContext = createAction({ document: document ? { id: document.id, - title: document.titleWithDefault, + title: document.displayTitle, path: document.url, } : undefined, @@ -69,7 +69,7 @@ export const searchWorkspace = createAction({ return JSON.stringify( results.map((result) => ({ id: result.document.id, - title: result.document.titleWithDefault, + title: result.document.displayTitle, path: result.document.url, context: result.context, })) diff --git a/app/actions/sections.ts b/app/actions/sections.ts index 6531dde2d4..699771bbf2 100644 --- a/app/actions/sections.ts +++ b/app/actions/sections.ts @@ -30,7 +30,7 @@ DocumentsSection.priority = 0.8; export const ActiveDocumentSection = ({ t, stores }: ActionContext) => { const activeDocument = stores.documents.active; - return `${t("Document")} · ${activeDocument?.titleWithDefault}`; + return `${t("Document")} · ${activeDocument?.displayTitle}`; }; ActiveDocumentSection.priority = 0.9; @@ -39,7 +39,7 @@ export const TemplateSection = ({ t }: ActionContext) => t("Template"); export const ActiveTemplateSection = ({ t, stores }: ActionContext) => { const activeTemplate = stores.templates.active; - return `${t("Template")} · ${activeTemplate?.titleWithDefault}`; + return `${t("Template")} · ${activeTemplate?.displayTitle}`; }; ActiveTemplateSection.priority = 0.9; diff --git a/app/components/CommandBar/useRecentDocumentActions.tsx b/app/components/CommandBar/useRecentDocumentActions.tsx index 2d5545286c..0da9ea7f1d 100644 --- a/app/components/CommandBar/useRecentDocumentActions.tsx +++ b/app/components/CommandBar/useRecentDocumentActions.tsx @@ -43,7 +43,7 @@ const useRecentDocumentActions = (count = recentDocumentCount) => { count ).map((item) => createInternalLinkAction({ - name: item.titleWithDefault, + name: item.displayTitle, analyticsName: "Recently viewed document", section: RecentSection, visible: ({ isMCP }) => !isMCP, diff --git a/app/components/CommandBar/useSearchIndex.ts b/app/components/CommandBar/useSearchIndex.ts index d81900984c..1ec692195d 100644 --- a/app/components/CommandBar/useSearchIndex.ts +++ b/app/components/CommandBar/useSearchIndex.ts @@ -49,7 +49,7 @@ export function toSearchRecord( ): SearchIndexDocument { return { id: doc.id, - title: doc.titleWithDefault, + title: doc.displayTitle, url: doc.url, text: doc.data ? getPlainText(doc) : stripHighlightTags(context), icon: doc.icon, diff --git a/app/components/CommandBar/useTemplatesAction.tsx b/app/components/CommandBar/useTemplatesAction.tsx index 8ce09d2d81..8aa6f09716 100644 --- a/app/components/CommandBar/useTemplatesAction.tsx +++ b/app/components/CommandBar/useTemplatesAction.tsx @@ -28,7 +28,7 @@ const useTemplatesAction = () => { () => templates.alphabetical.map((template) => createInternalLinkAction({ - name: template.titleWithDefault, + name: template.displayTitle, analyticsName: "New document", section: template.isWorkspaceTemplate ? TeamSection diff --git a/app/components/DialogTitle.tsx b/app/components/DialogTitle.tsx index 0085d43bd3..1e1a561db8 100644 --- a/app/components/DialogTitle.tsx +++ b/app/components/DialogTitle.tsx @@ -60,7 +60,7 @@ export const DialogTitle = observer(function DialogTitle_({ {icon} - {isDocument ? model.titleWithDefault : model.displayName} + {isDocument ? model.displayTitle : model.displayName} diff --git a/app/components/DocumentCard.tsx b/app/components/DocumentCard.tsx index 245dffb1c5..b471db8121 100644 --- a/app/components/DocumentCard.tsx +++ b/app/components/DocumentCard.tsx @@ -127,7 +127,7 @@ function DocumentCard(props: Props) { to={{ pathname: document.path, state: { - title: document.titleWithDefault, + title: document.displayTitle, }, }} > @@ -169,8 +169,8 @@ function DocumentCard(props: Props) {
{hasEmojiInTitle - ? document.titleWithDefault.replace(document.icon!, "") - : document.titleWithDefault} + ? document.displayTitle.replace(document.icon!, "") + : document.displayTitle} {isRecentlyUpdated ? ( diff --git a/app/components/DocumentChip.tsx b/app/components/DocumentChip.tsx index 5c45fb46ae..c39eab42fe 100644 --- a/app/components/DocumentChip.tsx +++ b/app/components/DocumentChip.tsx @@ -34,7 +34,7 @@ export const DocumentChip = observer(function DocumentChip_({ const { icon, color } = document; const canPin = usePolicy(pin); const canDocument = usePolicy(document); - const title = document.titleWithDefault; + const title = document.displayTitle; const isEmoji = determineIconType(icon) === IconType.Emoji; // Pins in a collection are governed by the document policy, pins on home by diff --git a/app/components/DocumentListItem.tsx b/app/components/DocumentListItem.tsx index 76bd7fcd18..278c76ec01 100644 --- a/app/components/DocumentListItem.tsx +++ b/app/components/DocumentListItem.tsx @@ -170,7 +170,7 @@ function DocumentListItem(props: Props) { pathname: documentPath(document), search: highlight ? `?q=${encodeURIComponent(highlight)}` : undefined, state: { - title: document.titleWithDefault, + title: document.displayTitle, sidebarContext, }, }} @@ -213,7 +213,7 @@ function DocumentListItem(props: Props) { diff --git a/app/components/Sidebar/components/SharedWithMeLink.tsx b/app/components/Sidebar/components/SharedWithMeLink.tsx index 43b345eb86..0aca26920e 100644 --- a/app/components/Sidebar/components/SharedWithMeLink.tsx +++ b/app/components/Sidebar/components/SharedWithMeLink.tsx @@ -184,7 +184,7 @@ function SharedWithMeLink({ membership, depth = 0 }: Props) { const label = determineIconType(docIcon) === IconType.Emoji ? document.title.replace(docIcon!, "") - : document.titleWithDefault; + : document.displayTitle; const collection = document.collectionId ? collections.get(document.collectionId) : undefined; diff --git a/app/components/Sidebar/components/StarredLink.tsx b/app/components/Sidebar/components/StarredLink.tsx index 2de85b68fd..6a48f7df56 100644 --- a/app/components/Sidebar/components/StarredLink.tsx +++ b/app/components/Sidebar/components/StarredLink.tsx @@ -222,7 +222,7 @@ const StarredDocumentLink = observer(function StarredDocumentLink({ depth={0} icon={icon} canEdit={can.update} - labelText={document.titleWithDefault} + labelText={document.displayTitle} onTitleChange={handleTitleChange} editableTitleRef={editableTitleRef} expanded={expanded} diff --git a/app/components/Sidebar/hooks/useSidebarLabelAndIcon.tsx b/app/components/Sidebar/hooks/useSidebarLabelAndIcon.tsx index eff563fb43..3b8cf5c4e5 100644 --- a/app/components/Sidebar/hooks/useSidebarLabelAndIcon.tsx +++ b/app/components/Sidebar/hooks/useSidebarLabelAndIcon.tsx @@ -28,7 +28,7 @@ export function useSidebarLabelAndIcon({ const collection = !document && collectionId ? collections.get(collectionId) : undefined; - const title = document?.titleWithDefault; + const title = document?.displayTitle; const documentIcon = document?.icon; const initial = document?.initial; const color = document?.color; diff --git a/app/editor/components/BlockMenu.tsx b/app/editor/components/BlockMenu.tsx index 5737fdf700..95ada775a6 100644 --- a/app/editor/components/BlockMenu.tsx +++ b/app/editor/components/BlockMenu.tsx @@ -55,10 +55,7 @@ function useTemplateMenuItem(isActive: boolean): MenuItem | undefined { const toMenuItem = (template: (typeof allTemplates)[0]): MenuItem => ({ name: "noop", - title: TextHelper.replaceTemplateVariables( - template.titleWithDefault, - user - ), + title: TextHelper.replaceTemplateVariables(template.displayTitle, user), icon: template.icon ? ( <Icon value={template.icon} @@ -68,7 +65,7 @@ function useTemplateMenuItem(isActive: boolean): MenuItem | undefined { ) : ( <DocumentIcon /> ), - keywords: template.titleWithDefault, + keywords: template.displayTitle, onClick: () => { const data = cloneDeep(template.data); ProsemirrorHelper.replaceTemplateVariables(data, user); diff --git a/app/editor/extensions/PasteHandler.tsx b/app/editor/extensions/PasteHandler.tsx index 14ac459653..312a5ec6d2 100644 --- a/app/editor/extensions/PasteHandler.tsx +++ b/app/editor/extensions/PasteHandler.tsx @@ -149,7 +149,7 @@ export default class PasteHandler extends Extension { state.schema.nodes.mention.create({ type: MentionType.Document, modelId: document.id, - label: document.titleWithDefault, + label: document.displayTitle, id: uuidv4(), anchorId: trimmedHash.length ? trimmedHash @@ -164,7 +164,7 @@ export default class PasteHandler extends Extension { IconType.Emoji; const title = `${hasEmoji ? document.icon + " " : ""}${ - document.titleWithDefault + document.displayTitle }`; this.insertLink(`${document.path}${hash}`, title); diff --git a/app/hooks/useTemplateMenuActions.tsx b/app/hooks/useTemplateMenuActions.tsx index f1d4a30765..ad1545b387 100644 --- a/app/hooks/useTemplateMenuActions.tsx +++ b/app/hooks/useTemplateMenuActions.tsx @@ -47,10 +47,7 @@ export function useTemplateMenuActions({ const templateToAction = useCallback( (template: Template): Action => createAction({ - name: TextHelper.replaceTemplateVariables( - template.titleWithDefault, - user - ), + name: TextHelper.replaceTemplateVariables(template.displayTitle, user), section: DocumentsSection, icon: template.icon ? ( <Icon diff --git a/app/menus/NewChildDocumentMenu.tsx b/app/menus/NewChildDocumentMenu.tsx index 81f351d827..7c5a084d4d 100644 --- a/app/menus/NewChildDocumentMenu.tsx +++ b/app/menus/NewChildDocumentMenu.tsx @@ -50,7 +50,7 @@ function NewChildDocumentMenu({ document }: Props) { <Trans defaults="New document in <em>{{ collectionName }}</em>" values={{ - collectionName: document.titleWithDefault, + collectionName: document.displayTitle, }} components={{ em: <strong />, @@ -66,7 +66,7 @@ function NewChildDocumentMenu({ document }: Props) { collectionName, canCollection.createDocument, document.id, - document.titleWithDefault, + document.displayTitle, document.collectionId, ] ); diff --git a/app/models/Document.ts b/app/models/Document.ts index 2051baf53e..2126347441 100644 --- a/app/models/Document.ts +++ b/app/models/Document.ts @@ -490,7 +490,7 @@ export default class Document extends ArchivableModel implements Searchable { return path.map((item) => item.asNavigationNode); } - get titleWithDefault(): string { + get displayTitle(): string { return this.title || i18n.t("Untitled"); } diff --git a/app/models/Template.ts b/app/models/Template.ts index 1705e716a6..517dc04875 100644 --- a/app/models/Template.ts +++ b/app/models/Template.ts @@ -185,13 +185,13 @@ export default class Template extends ParanoidModel implements Searchable { return addDays(new Date(this.deletedAt), 30).toString(); } - get titleWithDefault(): string { + get displayTitle(): string { return this.title || i18n.t("Untitled"); } @computed get initial(): string { - return (this.titleWithDefault?.charAt(0) ?? "?").toUpperCase(); + return (this.displayTitle?.charAt(0) ?? "?").toUpperCase(); } @computed diff --git a/app/scenes/Document/components/Document.tsx b/app/scenes/Document/components/Document.tsx index aaa1c7c6be..5b7df6c65b 100644 --- a/app/scenes/Document/components/Document.tsx +++ b/app/scenes/Document/components/Document.tsx @@ -371,8 +371,8 @@ function DocumentScene({ const hasEmojiInTitle = determineIconType(document.icon) === IconType.Emoji; const pageTitle = hasEmojiInTitle - ? document.titleWithDefault.replace(document.icon!, "") - : document.titleWithDefault; + ? document.displayTitle.replace(document.icon!, "") + : document.displayTitle; const favicon = hasEmojiInTitle ? emojiToUrl(document.icon!) : undefined; const fullWidthTransformOffsetStyle = { diff --git a/app/scenes/Document/components/Editor.tsx b/app/scenes/Document/components/Editor.tsx index 0c90e23f5c..a557f23b80 100644 --- a/app/scenes/Document/components/Editor.tsx +++ b/app/scenes/Document/components/Editor.tsx @@ -227,9 +227,7 @@ function DocumentEditor(props: Props) { readOnly={readOnly} documentId={document.id} title={ - !document.title && readOnly - ? document.titleWithDefault - : document.title + !document.title && readOnly ? document.displayTitle : document.title } icon={document.icon} color={iconColor} diff --git a/app/scenes/Document/components/ReferenceListItem.tsx b/app/scenes/Document/components/ReferenceListItem.tsx index 17259c84cc..dee72da7ae 100644 --- a/app/scenes/Document/components/ReferenceListItem.tsx +++ b/app/scenes/Document/components/ReferenceListItem.tsx @@ -238,7 +238,7 @@ function ReferenceListItem({ const { icon, color } = document; const isEmoji = determineIconType(icon) === IconType.Emoji; const title = - document instanceof Document ? document.titleWithDefault : document.title; + document instanceof Document ? document.displayTitle : document.title; const initial = title.charAt(0).toUpperCase(); const showContextMenu = document instanceof Document && !!user; diff --git a/app/scenes/DocumentDelete.tsx b/app/scenes/DocumentDelete.tsx index 2e4031fc87..a8d05716b9 100644 --- a/app/scenes/DocumentDelete.tsx +++ b/app/scenes/DocumentDelete.tsx @@ -109,7 +109,7 @@ function DocumentDelete({ document, onSubmit }: Props) { <Trans defaults="Are you sure about that? Deleting the <em>{{ documentTitle }}</em> document will delete all of its history." values={{ - documentTitle: document.titleWithDefault, + documentTitle: document.displayTitle, }} components={{ em: <strong />, @@ -120,7 +120,7 @@ function DocumentDelete({ document, onSubmit }: Props) { count={nestedDocumentsCount} defaults="Are you sure about that? Deleting the <em>{{ documentTitle }}</em> document will delete all of its history and <em>{{ any }} nested document</em>." values={{ - documentTitle: document.titleWithDefault, + documentTitle: document.displayTitle, any: nestedDocumentsCount, }} components={{ diff --git a/app/scenes/DocumentPermanentDelete.tsx b/app/scenes/DocumentPermanentDelete.tsx index a7cf03da53..9c7465a6e2 100644 --- a/app/scenes/DocumentPermanentDelete.tsx +++ b/app/scenes/DocumentPermanentDelete.tsx @@ -37,7 +37,7 @@ function DocumentPermanentDelete({ document, onSubmit }: Props) { <Trans defaults="Are you sure you want to permanently delete the <em>{{ documentTitle }}</em> document? This action is immediate and cannot be undone." values={{ - documentTitle: document.titleWithDefault, + documentTitle: document.displayTitle, }} components={{ em: <strong />, diff --git a/app/scenes/Search/components/DocumentFilter.tsx b/app/scenes/Search/components/DocumentFilter.tsx index f634cc7027..5416d5a370 100644 --- a/app/scenes/Search/components/DocumentFilter.tsx +++ b/app/scenes/Search/components/DocumentFilter.tsx @@ -19,7 +19,7 @@ export function DocumentFilter(props: Props) { <div> <Tooltip content={t("Remove document filter")}> <StyledButton onClick={props.onClick} icon={<CloseIcon />} neutral> - {props.document.titleWithDefault} + {props.document.displayTitle} </StyledButton> </Tooltip> </div> diff --git a/app/scenes/Settings/components/TemplatesTable.tsx b/app/scenes/Settings/components/TemplatesTable.tsx index b46a3e7224..c59dc96ab3 100644 --- a/app/scenes/Settings/components/TemplatesTable.tsx +++ b/app/scenes/Settings/components/TemplatesTable.tsx @@ -89,7 +89,7 @@ export function TemplatesTable(props: Props) { type: "data", id: "title", header: t("Title"), - accessor: (template) => template.titleWithDefault, + accessor: (template) => template.displayTitle, component: (template) => <TemplateLink template={template} />, width: "4fr", }, @@ -167,9 +167,9 @@ const TemplateLink = observer(({ template }: { template: Template }) => { <ShapesIcon size={24} color={theme.textSecondary} /> )} {can.update ? ( - <Title>{template.titleWithDefault} + {template.displayTitle} ) : ( - {template.titleWithDefault} + {template.displayTitle} )} {template.isDraft && ( diff --git a/app/stores/UiStore.ts b/app/stores/UiStore.ts index 410ff39eba..a97425518d 100644 --- a/app/stores/UiStore.ts +++ b/app/stores/UiStore.ts @@ -130,7 +130,7 @@ class UiStore { setPresentingDocument = (document: Document | null): void => { this.presentationData = document ? { - title: document.titleWithDefault, + title: document.displayTitle, icon: document.icon, color: document.color, data: document.data, diff --git a/plugins/slack/server/presenters/messageAttachment.ts b/plugins/slack/server/presenters/messageAttachment.ts index b7e6193637..8caf03f67e 100644 --- a/plugins/slack/server/presenters/messageAttachment.ts +++ b/plugins/slack/server/presenters/messageAttachment.ts @@ -22,7 +22,7 @@ export function presentMessageAttachment( return { color: collection?.color, - title: document.titleWithDefault, + title: document.displayTitle, title_link: `${team.url}${document.url}`, footer: collection?.name, callback_id: document.id, diff --git a/plugins/slack/server/processors/SlackProcessor.ts b/plugins/slack/server/processors/SlackProcessor.ts index 50a81b47a5..4c6aee432f 100644 --- a/plugins/slack/server/processors/SlackProcessor.ts +++ b/plugins/slack/server/processors/SlackProcessor.ts @@ -124,10 +124,10 @@ export default class SlackProcessor extends BaseProcessor { if (!integration) { return; } - let text = `${document.updatedBy.name} updated "${document.titleWithDefault}"`; + let text = `${document.updatedBy.name} updated "${document.displayTitle}"`; if (event.name === "documents.publish") { - text = `${document.createdBy.name} published "${document.titleWithDefault}"`; + text = `${document.createdBy.name} published "${document.displayTitle}"`; } await fetch(integration.settings.url, { diff --git a/server/emails/templates/CommentCreatedEmail.tsx b/server/emails/templates/CommentCreatedEmail.tsx index 910e33a157..2192a589c8 100644 --- a/server/emails/templates/CommentCreatedEmail.tsx +++ b/server/emails/templates/CommentCreatedEmail.tsx @@ -106,7 +106,7 @@ export default class CommentCreatedEmail extends BaseEmail< return `${parentComment ? this.t("Re") + ": " : ""}${this.t( "New comment on “{{ documentTitle }}” - {{ trimmedText }}", - { documentTitle: document.titleWithDefault, trimmedText } + { documentTitle: document.displayTitle, trimmedText } )}`; } @@ -140,11 +140,11 @@ export default class CommentCreatedEmail extends BaseEmail< const action = isReply ? this.t("{{ actorName }} replied to a thread in “{{ documentTitle }}”", { actorName, - documentTitle: document.titleWithDefault, + documentTitle: document.displayTitle, }) : this.t("{{ actorName }} commented on “{{ documentTitle }}”", { actorName, - documentTitle: document.titleWithDefault, + documentTitle: document.displayTitle, }); const inCollection = collection?.name ? ` ${this.t("in the {{ collectionName }} collection", { collectionName: collection.name })}` @@ -178,12 +178,12 @@ ${this.t("Open Thread")}: ${teamUrl}${document.url}?commentId=${commentId}
- {document.titleWithDefault} + {document.displayTitle}

{isReply ? this.t("{{ actorName }} replied to a thread in", { actorName }) : this.t("{{ actorName }} commented on", { actorName })}{" "} - {document.titleWithDefault}{" "} + {document.displayTitle}{" "} {collection?.name ? this.t("in the {{ collectionName }} collection", { collectionName: collection.name, diff --git a/server/emails/templates/CommentMentionedEmail.tsx b/server/emails/templates/CommentMentionedEmail.tsx index 69691abaf2..260de7b305 100644 --- a/server/emails/templates/CommentMentionedEmail.tsx +++ b/server/emails/templates/CommentMentionedEmail.tsx @@ -95,7 +95,7 @@ export default class CommentMentionedEmail extends BaseEmail< protected subject({ document }: Props) { return this.t("Mentioned you in “{{ documentTitle }}”", { - documentTitle: document.titleWithDefault, + documentTitle: document.displayTitle, }); } @@ -116,7 +116,7 @@ export default class CommentMentionedEmail extends BaseEmail< }: Props): string { const action = this.t( "{{ actorName }} mentioned you in a comment on “{{ documentTitle }}”", - { actorName, documentTitle: document.titleWithDefault } + { actorName, documentTitle: document.displayTitle } ); const inCollection = collection.name ? ` ${this.t("in the {{ collectionName }} collection", { collectionName: collection.name })}` @@ -149,12 +149,12 @@ ${this.t("Open Thread")}: ${teamUrl}${document.url}?commentId=${commentId}

- {document.titleWithDefault} + {document.displayTitle}

{this.t("{{ actorName }} mentioned you in a comment on", { actorName, })}{" "} - {document.titleWithDefault}{" "} + {document.displayTitle}{" "} {collection.name ? this.t("in the {{ collectionName }} collection", { collectionName: collection.name, diff --git a/server/emails/templates/CommentResolvedEmail.tsx b/server/emails/templates/CommentResolvedEmail.tsx index 91d0ded895..4f4b312782 100644 --- a/server/emails/templates/CommentResolvedEmail.tsx +++ b/server/emails/templates/CommentResolvedEmail.tsx @@ -95,7 +95,7 @@ export default class CommentResolvedEmail extends BaseEmail< protected subject({ document }: Props) { return this.t("Resolved a comment thread in “{{ documentTitle }}”", { - documentTitle: document.titleWithDefault, + documentTitle: document.displayTitle, }); } @@ -116,7 +116,7 @@ export default class CommentResolvedEmail extends BaseEmail< }: Props): string { const action = this.t( "{{ actorName }} resolved a comment thread on “{{ documentTitle }}”", - { actorName, documentTitle: document.titleWithDefault } + { actorName, documentTitle: document.displayTitle } ); const inCollection = collection.name ? ` ${this.t("in the {{ collectionName }} collection", { collectionName: collection.name })}` @@ -145,10 +145,10 @@ export default class CommentResolvedEmail extends BaseEmail<

- {document.titleWithDefault} + {document.displayTitle}

{this.t("{{ actorName }} resolved a comment on", { actorName })}{" "} - {document.titleWithDefault}{" "} + {document.displayTitle}{" "} {collection.name ? this.t("in the {{ collectionName }} collection", { collectionName: collection.name, diff --git a/server/emails/templates/DocumentAccessRequestEmail.tsx b/server/emails/templates/DocumentAccessRequestEmail.tsx index 94c9fe198b..db7fba073a 100644 --- a/server/emails/templates/DocumentAccessRequestEmail.tsx +++ b/server/emails/templates/DocumentAccessRequestEmail.tsx @@ -47,7 +47,7 @@ export default class DocumentAccessRequestEmail extends BaseEmail< } protected subject({ actor, document }: Props) { - return `${actor.name} is requesting access to "${document.titleWithDefault}"`; + return `${actor.name} is requesting access to "${document.displayTitle}"`; } protected preview({ actor }: Props): string { @@ -60,7 +60,7 @@ export default class DocumentAccessRequestEmail extends BaseEmail< protected renderAsText({ actor, teamUrl, document }: Props): string { return ` -${actor.name} is requesting access to "${document.titleWithDefault}". +${actor.name} is requesting access to "${document.displayTitle}". Open the document to share it with them: ${teamUrl}${document.path} `; @@ -78,10 +78,10 @@ Open the document to share it with them: ${teamUrl}${document.path}

- {document.titleWithDefault} + {document.displayTitle}

{actor.name} is requesting access to the{" "} - {document.titleWithDefault} document. + {document.displayTitle} document.

Open the document to share it with them.

diff --git a/server/emails/templates/DocumentMentionedEmail.tsx b/server/emails/templates/DocumentMentionedEmail.tsx index 0f0a7a910a..2e92501a3c 100644 --- a/server/emails/templates/DocumentMentionedEmail.tsx +++ b/server/emails/templates/DocumentMentionedEmail.tsx @@ -94,7 +94,7 @@ export default class DocumentMentionedEmail extends BaseEmail< protected subject({ document }: Props) { return this.t(`Mentioned you in “{{ documentTitle }}”`, { - documentTitle: document.titleWithDefault, + documentTitle: document.displayTitle, }); } @@ -119,7 +119,7 @@ export default class DocumentMentionedEmail extends BaseEmail< return ` ${this.t("You were mentioned")} -${this.t(`{{ actorName }} mentioned you in the document “{{ documentTitle }}”.`, { actorName, documentTitle: document.titleWithDefault })} +${this.t(`{{ actorName }} mentioned you in the document “{{ documentTitle }}”.`, { actorName, documentTitle: document.displayTitle })} ${this.t("Open Document")}: ${teamUrl}${document.url} `; @@ -142,7 +142,7 @@ ${this.t("Open Document")}: ${teamUrl}${document.url} {this.t("{{ actorName }} mentioned you in the document", { actorName, })}{" "} - {document.titleWithDefault}. + {document.displayTitle}.

{body && ( <> diff --git a/server/emails/templates/DocumentPublishedOrUpdatedEmail.tsx b/server/emails/templates/DocumentPublishedOrUpdatedEmail.tsx index 770c548663..3d1ac5068d 100644 --- a/server/emails/templates/DocumentPublishedOrUpdatedEmail.tsx +++ b/server/emails/templates/DocumentPublishedOrUpdatedEmail.tsx @@ -118,7 +118,7 @@ export default class DocumentPublishedOrUpdatedEmail extends BaseEmail< protected subject({ document, eventType }: Props) { return this.t(`“{{ documentTitle }}” {{ eventName }}`, { - documentTitle: document.titleWithDefault, + documentTitle: document.displayTitle, eventName: this.eventName(eventType), }); } @@ -153,9 +153,9 @@ export default class DocumentPublishedOrUpdatedEmail extends BaseEmail< const eventName = this.eventName(eventType); return ` -${this.t("“{{ documentTitle }}” {{ eventName }}", { documentTitle: document.titleWithDefault, eventName })} +${this.t("“{{ documentTitle }}” {{ eventName }}", { documentTitle: document.displayTitle, eventName })} -${this.t("{{ actorName }} {{ eventName }} the document “{{ documentTitle }}”", { actorName, eventName, documentTitle: document.titleWithDefault })}${ +${this.t("{{ actorName }} {{ eventName }} the document “{{ documentTitle }}”", { actorName, eventName, documentTitle: document.displayTitle })}${ collection?.name ? `, ${this.t("in the {{ collectionName }} collection", { collectionName: collection.name })}` : "" @@ -188,7 +188,7 @@ ${this.t("Open Document")}: ${teamUrl}${document.url} {this.t(`“{{ documentTitle }}” {{ eventName }}`, { - documentTitle: document.titleWithDefault, + documentTitle: document.displayTitle, eventName, })} @@ -197,7 +197,7 @@ ${this.t("Open Document")}: ${teamUrl}${document.url} actorName, eventName, })}{" "} - {document.titleWithDefault} + {document.displayTitle} {collection?.name ? ( <> ,{" "} diff --git a/server/emails/templates/DocumentSharedEmail.tsx b/server/emails/templates/DocumentSharedEmail.tsx index b1cb1b7c5e..207ccda214 100644 --- a/server/emails/templates/DocumentSharedEmail.tsx +++ b/server/emails/templates/DocumentSharedEmail.tsx @@ -59,7 +59,7 @@ export default class DocumentSharedEmail extends BaseEmail< protected subject({ actorName, document }: Props) { return this.t(`{{ actorName }} shared “{{ documentTitle }}” with you`, { actorName, - documentTitle: document.titleWithDefault, + documentTitle: document.displayTitle, }); } @@ -73,7 +73,7 @@ export default class DocumentSharedEmail extends BaseEmail< protected renderAsText({ actorName, teamUrl, document }: Props): string { return ` -${this.t(`{{ actorName }} shared “{{ documentTitle }}” with you.`, { actorName, documentTitle: document.titleWithDefault })} +${this.t(`{{ actorName }} shared “{{ documentTitle }}” with you.`, { actorName, documentTitle: document.displayTitle })} ${this.t("View Document")}: ${teamUrl}${document.path} `; @@ -96,13 +96,13 @@ ${this.t("View Document")}: ${teamUrl}${document.path}
- {document.titleWithDefault} + {document.displayTitle}

{this.t("{{ actorName }} invited you to {{ permission }} the", { actorName, permission, })}{" "} - {document.titleWithDefault}{" "} + {document.displayTitle}{" "} {this.t("document")}.

diff --git a/server/emails/templates/GroupCommentMentionedEmail.tsx b/server/emails/templates/GroupCommentMentionedEmail.tsx index 56957114e8..1a31c0c7c1 100644 --- a/server/emails/templates/GroupCommentMentionedEmail.tsx +++ b/server/emails/templates/GroupCommentMentionedEmail.tsx @@ -104,7 +104,7 @@ export default class GroupCommentMentionedEmail extends BaseEmail< protected subject({ document, groupName }: Props) { return this.t( "The {{ groupName }} group was mentioned in “{{ documentTitle }}”", - { groupName, documentTitle: document.titleWithDefault } + { groupName, documentTitle: document.displayTitle } ); } @@ -129,7 +129,7 @@ export default class GroupCommentMentionedEmail extends BaseEmail< }: Props): string { const action = this.t( "{{ actorName }} mentioned the “{{ groupName }}” group in a comment on “{{ documentTitle }}”", - { actorName, groupName, documentTitle: document.titleWithDefault } + { actorName, groupName, documentTitle: document.displayTitle } ); const inCollection = collection.name ? ` ${this.t("in the {{ collectionName }} collection", { collectionName: collection.name })}` @@ -163,13 +163,13 @@ ${this.t("Open Thread")}: ${teamUrl}${document.url}?commentId=${commentId}

- {document.titleWithDefault} + {document.displayTitle}

{this.t( "{{ actorName }} mentioned the “{{ groupName }}” group in a comment on", { actorName, groupName } )}{" "} - {document.titleWithDefault}{" "} + {document.displayTitle}{" "} {collection.name ? this.t("in the {{ collectionName }} collection", { collectionName: collection.name, diff --git a/server/emails/templates/GroupDocumentMentionedEmail.tsx b/server/emails/templates/GroupDocumentMentionedEmail.tsx index 31c29eca62..3db3b76aaa 100644 --- a/server/emails/templates/GroupDocumentMentionedEmail.tsx +++ b/server/emails/templates/GroupDocumentMentionedEmail.tsx @@ -103,7 +103,7 @@ export default class GroupDocumentMentionedEmail extends BaseEmail< `The {{ groupName }} group was mentioned in “{{ documentTitle }}”`, { groupName, - documentTitle: document.titleWithDefault, + documentTitle: document.displayTitle, } ); } @@ -135,7 +135,7 @@ export default class GroupDocumentMentionedEmail extends BaseEmail< groupName, }: Props): string { return ` -${this.t(`{{ actorName }} mentioned the “{{ groupName }}” group in the document “{{ documentTitle }}”.`, { actorName, groupName, documentTitle: document.titleWithDefault })} +${this.t(`{{ actorName }} mentioned the “{{ groupName }}” group in the document “{{ documentTitle }}”.`, { actorName, groupName, documentTitle: document.displayTitle })} ${this.t("Open Document")}: ${teamUrl}${document.url} `; @@ -159,7 +159,7 @@ ${this.t("Open Document")}: ${teamUrl}${document.url} "{{ actorName }} mentioned the “{{ groupName }}” group in the document", { actorName, groupName } )}{" "} - {document.titleWithDefault}. + {document.displayTitle}.

{body && ( <> diff --git a/server/models/Document.ts b/server/models/Document.ts index fb4005d540..43cebb06e6 100644 --- a/server/models/Document.ts +++ b/server/models/Document.ts @@ -1107,7 +1107,7 @@ class Document extends ArchivableModel< * * @returns boolean */ - get titleWithDefault(): string { + get displayTitle(): string { return this.title || "Untitled"; } diff --git a/server/models/FileOperation.ts b/server/models/FileOperation.ts index 2282a59ec9..db7e78ec28 100644 --- a/server/models/FileOperation.ts +++ b/server/models/FileOperation.ts @@ -178,7 +178,7 @@ class FileOperation extends ParanoidModel< const source = "document" in options ? { - name: options.document.titleWithDefault, + name: options.document.displayTitle, documentId: options.document.id, teamId: options.document.teamId, options: personalOwnerId ? { personalOwnerId } : null, diff --git a/server/models/helpers/OKFHelper.ts b/server/models/helpers/OKFHelper.ts index 42c961ed83..e1b4bb365f 100644 --- a/server/models/helpers/OKFHelper.ts +++ b/server/models/helpers/OKFHelper.ts @@ -63,7 +63,7 @@ export default class OKFHelper { const data: Frontmatter = { type: this.conceptType, - title: document.titleWithDefault, + title: document.displayTitle, ...(description ? { description } : {}), resource: `${origin}${document.path}`, status: this.status(document), diff --git a/server/presenters/fileOperation.ts b/server/presenters/fileOperation.ts index 0c624e0e2a..4df2331f83 100644 --- a/server/presenters/fileOperation.ts +++ b/server/presenters/fileOperation.ts @@ -9,7 +9,7 @@ export default function presentFileOperation(data: FileOperation) { format: data.format, name: data.collection?.name || - data.document?.titleWithDefault || + data.document?.displayTitle || path.basename(data.key || ""), state: data.state, error: data.error, diff --git a/server/presenters/unfurl.ts b/server/presenters/unfurl.ts index 3633fb4cca..18d14dc1c2 100644 --- a/server/presenters/unfurl.ts +++ b/server/presenters/unfurl.ts @@ -114,7 +114,7 @@ const presentDocument = ( url: url ?? `${document.url}${anchor ?? ""}`, type: UnfurlResourceType.Document, id: document.id, - title: document.titleWithDefault, + title: document.displayTitle, summary: sectionSummary || document.getSummary(), lastActivityByViewer: viewer ? presentLastActivityInfoFor(document, viewer) diff --git a/server/queues/tasks/ExportDocumentTreeTask.ts b/server/queues/tasks/ExportDocumentTreeTask.ts index 3a39fa9559..04c584e13e 100644 --- a/server/queues/tasks/ExportDocumentTreeTask.ts +++ b/server/queues/tasks/ExportDocumentTreeTask.ts @@ -289,7 +289,7 @@ export default abstract class ExportDocumentTreeTask extends ExportTask { }) { const pathMap = new Map(); - const rootFolderName = serializeFilename(document.titleWithDefault); + const rootFolderName = serializeFilename(document.displayTitle); const rootPath = `${rootFolderName}.${ExportDocumentTreeTask.extensionForFormat(format)}`; // entry for root document @@ -317,7 +317,7 @@ export default abstract class ExportDocumentTreeTask extends ExportTask { Buffer.from( OKFHelper.rootIndex("Documents", [ { - title: document.titleWithDefault, + title: document.displayTitle, path: rootPath, description: document.getSummary(), }, diff --git a/server/queues/tasks/ShareSubscriptionNotificationsTask.ts b/server/queues/tasks/ShareSubscriptionNotificationsTask.ts index 674bb652b6..7a5b0ecdb7 100644 --- a/server/queues/tasks/ShareSubscriptionNotificationsTask.ts +++ b/server/queues/tasks/ShareSubscriptionNotificationsTask.ts @@ -72,7 +72,7 @@ export default class ShareSubscriptionNotificationsTask extends BaseTask { const body = await res.json(); expect(res.status).toEqual(200); expect(body.type).toEqual(UnfurlResourceType.Document); - expect(body.title).toEqual(document.titleWithDefault); + expect(body.title).toEqual(document.displayTitle); expect(body.id).toEqual(document.id); }); @@ -348,7 +348,7 @@ Install instructions here.` const body = await res.json(); expect(res.status).toEqual(200); expect(body.type).toEqual(UnfurlResourceType.Document); - expect(body.title).toEqual(document.titleWithDefault); + expect(body.title).toEqual(document.displayTitle); expect(body.id).toEqual(document.id); }); @@ -372,7 +372,7 @@ Install instructions here.` const body = await res.json(); expect(res.status).toEqual(200); expect(body.type).toEqual(UnfurlResourceType.Document); - expect(body.title).toEqual(document.titleWithDefault); + expect(body.title).toEqual(document.displayTitle); expect(body.id).toEqual(document.id); }); @@ -395,7 +395,7 @@ Install instructions here.` const body = await res.json(); expect(res.status).toEqual(200); expect(body.type).toEqual(UnfurlResourceType.Document); - expect(body.title).toEqual(document.titleWithDefault); + expect(body.title).toEqual(document.displayTitle); expect(body.id).toEqual(document.id); });