release: 0.40.6

RyotaUshio · Jun 11, 2024 · f527c6a · f527c6a
1 parent 797f24e
commit f527c6a
Show file tree

Hide file tree

Showing 18 changed files with 110 additions and 63 deletions.
diff --git a/manifest-beta.json b/manifest-beta.json
@@ -1,7 +1,7 @@
 {
     "id": "pdf-plus",
     "name": "PDF++",
-    "version": "0.40.5",
+    "version": "0.40.6",
     "minAppVersion": "1.4.16",
     "description": "The most Obsidian-native PDF annotation tool ever.",
     "author": "Ryota Ushio",

diff --git a/manifest.json b/manifest.json
@@ -1,7 +1,7 @@
 {
     "id": "pdf-plus",
     "name": "PDF++",
-    "version": "0.40.5",
+    "version": "0.40.6",
     "minAppVersion": "1.4.16",
     "description": "The most Obsidian-native PDF annotation tool ever.",
     "author": "Ryota Ushio",

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "obsidian-pdf-plus",
-    "version": "0.40.5",
+    "version": "0.40.6",
     "description": "The most Obsidian-native PDF annotation tool ever.",
     "scripts": {
         "dev": "node esbuild.config.mjs",

diff --git a/src/bib.ts b/src/bib.ts
@@ -4,7 +4,7 @@ import { PDFDocumentProxy } from 'pdfjs-dist';
 import PDFPlus from 'main';
 import { PDFPlusComponent } from 'lib/component';
 import { genId, isCanvas, isEmbed, isHoverPopover, isNonEmbedLike, onModKeyPress, toSingleLine } from 'utils';
-import { PDFViewerChild, PDFjsDestArray, TextContentItem } from 'typings';
+import { PDFViewerChild, PDFJsDestArray, TextContentItem } from 'typings';
 
 
 export type AnystyleJson = Partial<{
@@ -61,7 +61,7 @@ export class BibliographyManager extends PDFPlusComponent {
                 const promises: Promise<void>[] = [];
                 for (const destId in dests) {
                     if (destId.startsWith('cite.')) {
-                        const destArray = dests[destId] as PDFjsDestArray;
+                        const destArray = dests[destId] as PDFJsDestArray;
                         promises.push(
                             BibliographyManager.getBibliographyTextFromDest(destArray, doc)
                                 .then((bibInfo) => {
@@ -151,7 +151,8 @@ export class BibliographyManager extends PDFPlusComponent {
             // Clean up the file when this PDF viewer is unloaded
             this.register(() => app.vault.adapter.remove(anystyleInputPath));
 
-            const { spawn } = await import('child_process');
+            // eslint-disable-next-line @typescript-eslint/no-var-requires
+            const { spawn } = require('child_process') as typeof import('child_process');
 
             return new Promise<any>((resolve) => {
                 const anystyleProcess = spawn(anystylePath, ['parse', anystyleInputFullPath]);
@@ -208,10 +209,10 @@ export class BibliographyManager extends PDFPlusComponent {
         return null;
     }
 
-    static async getBibliographyTextFromDest(dest: string | PDFjsDestArray, doc: PDFDocumentProxy) {
-        let explicitDest: PDFjsDestArray | null = null;
+    static async getBibliographyTextFromDest(dest: string | PDFJsDestArray, doc: PDFDocumentProxy) {
+        let explicitDest: PDFJsDestArray | null = null;
         if (typeof dest === 'string') {
-            explicitDest = (await doc.getDestination(dest)) as PDFjsDestArray | null;
+            explicitDest = (await doc.getDestination(dest)) as PDFJsDestArray | null;
         } else {
             explicitDest = dest;
         }

diff --git a/src/color-palette.ts b/src/color-palette.ts
@@ -116,7 +116,8 @@ export class ColorPalette extends PDFPlusComponent {
         itemEl.createDiv(ColorPalette.CLS + '-item-inner');
         this.setTooltipToActionItem(itemEl, name);
 
-        itemEl.addEventListener('click', (evt) => this.onItemClick(itemEl, name, evt));
+        // Listen to pointerup, not click, to prevent the selection from being cleared before the handler is called on mobile devices.
+        itemEl.addEventListener('pointerup', (evt) => this.onItemPointerUp(itemEl, name, evt));
 
         let shown = false;
         itemEl.addEventListener('contextmenu', () => {
@@ -140,7 +141,7 @@ export class ColorPalette extends PDFPlusComponent {
         });
     }
 
-    onItemClick(itemEl: HTMLElement, name: string | null, evt: MouseEvent) {
+    onItemPointerUp(itemEl: HTMLElement, name: string | null, evt: MouseEvent) {
         const colorChanged = !itemEl.hasClass('is-active');
         this.setActiveItem(name);
         if (this.plugin.settings.syncColorPaletteItem && this.plugin.settings.syncDefaultColorPaletteItem) {
@@ -159,7 +160,7 @@ export class ColorPalette extends PDFPlusComponent {
             this.lib.copyLink.copyLinkToSelection(false, { copyFormat: template }, name ?? undefined);
         }
 
-        evt.preventDefault(); 
+        evt.preventDefault();
     }
 
     setActiveItem(name: string | null) {

diff --git a/src/context-menu.ts b/src/context-menu.ts
@@ -198,7 +198,7 @@ export const onOutlineItemContextMenu = (plugin: PDFPlus, child: PDFViewerChild,
                         plugin.lastCopiedDestInfo = { file, destName: dest };
                     } else {
                         const pageNumber = await item.getPageNumber();
-                        const destArray = lib.normalizePDFjsDestArray(dest, pageNumber);
+                        const destArray = lib.normalizePDFJsDestArray(dest, pageNumber);
                         plugin.lastCopiedDestInfo = { file, destArray };
                     }
                 })
@@ -706,7 +706,7 @@ export class PDFPlusContextMenu extends PDFPlusMenu {
                     .setIcon('lucide-copy')
                     .onClick(() => {
                         // How does the electron version differ?
-                        navigator.clipboard.writeText(selectedText);
+                        navigator.clipboard.writeText(this.plugin.settings.copyAsSingleLine ? selectedText : (selectionObj?.toString() ?? ''));
                     });
             });
         }

diff --git a/src/lib/copy-link.ts b/src/lib/copy-link.ts
@@ -171,7 +171,7 @@ export class copyLinkLib extends PDFPlusLibSubmodule {
     async getTextToCopyForOutlineItemDynamic(child: PDFViewerChild, file: TFile, item: PDFOutlineTreeNode) {
         const dest = await item.getExplicitDestination();
         const pageNumber = await item.getPageNumber();
-        const destArray = this.lib.normalizePDFjsDestArray(dest, pageNumber);
+        const destArray = this.lib.normalizePDFJsDestArray(dest, pageNumber);
         const subpath = this.lib.destArrayToSubpath(destArray);
 
         return (sourcePath?: string) => this.getTextToCopy(

diff --git a/src/lib/index.ts b/src/lib/index.ts
@@ -14,11 +14,10 @@ import { PDFOutlines } from './outlines';
 import { NameTree, NumberTree } from './name-or-number-trees';
 import { PDFNamedDestinations } from './destinations';
 import { PDFPageLabels } from './page-labels';
-import { AnnotationElement, CanvasFileNode, CanvasNode, CanvasView, DestArray, EventBus, ObsidianViewer, PDFOutlineViewer, PDFPageView, PDFSidebar, PDFThumbnailView, PDFView, PDFViewExtraState, PDFViewerChild, PDFjsDestArray, PDFViewer, PDFEmbed, PDFViewState, Rect, TextContentItem, PDFFindBar, PDFSearchSettings } from 'typings';
+import { AnnotationElement, CanvasFileNode, CanvasNode, CanvasView, DestArray, EventBus, ObsidianViewer, PDFPageView, PDFView, PDFViewExtraState, PDFViewerChild, PDFJsDestArray, PDFViewer, PDFEmbed, PDFViewState, Rect, TextContentItem, PDFFindBar, PDFSearchSettings, PDFJsEventMap } from 'typings';
 import { PDFCroppedEmbed } from 'pdf-cropped-embed';
 import { PDFBacklinkIndex } from './pdf-backlink-index';
 import { Speech } from './speech';
-import { SidebarView } from 'pdfjs-enums';
 
 
 export class PDFPlusLib {
@@ -54,18 +53,7 @@ export class PDFPlusLib {
     /** 
      * @param component A component such that the callback is unregistered when the component is unloaded, or `null` if the callback should be called only once.
      */
-    registerPDFEvent(name: 'outlineloaded', eventBus: EventBus, component: Component | null, callback: (data: { source: PDFOutlineViewer, outlineCount: number, currentOutlineItemPromise: Promise<void> }) => any): void;
-    registerPDFEvent(name: 'thumbnailrendered', eventBus: EventBus, component: Component | null, callback: (data: { source: PDFThumbnailView, pageNumber: number, pdfPage: PDFPageProxy }) => any): void;
-    registerPDFEvent(name: 'sidebarviewchanged', eventBus: EventBus, component: Component | null, callback: (data: { source: PDFSidebar, view: SidebarView }) => any): void;
-    registerPDFEvent(name: 'textlayerrendered', eventBus: EventBus, component: Component | null, callback: (data: { source: PDFPageView, pageNumber: number }) => any): void;
-    registerPDFEvent(name: 'annotationlayerrendered', eventBus: EventBus, component: Component | null, callback: (data: { source: PDFPageView, pageNumber: number }) => any): void;
-    registerPDFEvent(name: 'pagesloaded', eventBus: EventBus, component: Component | null, callback: (data: { source: PDFViewer, pagesCount: number }) => any): void;
-    registerPDFEvent(name: 'pagerendered', eventBus: EventBus, component: Component | null, callback: (data: { source: PDFPageView, pageNumber: number, cssTransform: boolean, timestamp: number, error: any }) => any): void;
-    registerPDFEvent(name: 'pagechanging', eventBus: EventBus, component: Component | null, callback: (data: { source: PDFViewer, pageNumber: number, pageLabel: string | null, previous: number }) => any): void;
-    registerPDFEvent(name: 'findbaropen', eventBus: EventBus, component: Component | null, callback: (data: { source: PDFFindBar }) => any): void;
-    registerPDFEvent(name: 'findbarclose', eventBus: EventBus, component: Component | null, callback: (data: { source: PDFFindBar }) => any): void;
-
-    registerPDFEvent(name: string, eventBus: EventBus, component: Component | null, callback: (data: any) => any) {
+    registerPDFEvent<K extends keyof PDFJsEventMap>(name: K, eventBus: EventBus, component: Component | null, callback: (data: PDFJsEventMap[K]) => any) {
         const listener = async (data: any) => {
             await callback(data);
             if (!component) eventBus.off(name, listener);
@@ -293,22 +281,22 @@ export class PDFPlusLib {
      *       shall be retained unchanged. A zoom value of 0 has the same meaning as a null value."
      */
     async destIdToSubpath(destId: string, doc: PDFDocumentProxy) {
-        const dest = await doc.getDestination(destId) as PDFjsDestArray;
+        const dest = await doc.getDestination(destId) as PDFJsDestArray;
         if (!dest) return null;
         return this.pdfJsDestArrayToSubpath(dest, doc);
     }
 
-    async pdfJsDestArrayToSubpath(dest: PDFjsDestArray, doc: PDFDocumentProxy) {
+    async pdfJsDestArrayToSubpath(dest: PDFJsDestArray, doc: PDFDocumentProxy) {
         const page = await doc.getPageIndex(dest[0]);
-        return this.destArrayToSubpath(this.normalizePDFjsDestArray(dest, page + 1));
+        return this.destArrayToSubpath(this.normalizePDFJsDestArray(dest, page + 1));
     }
 
     /**
      * 
      * @param dest 
      * @param pageNumber 1-based page number
      */
-    normalizePDFjsDestArray(dest: PDFjsDestArray, pageNumber: number): DestArray {
+    normalizePDFJsDestArray(dest: PDFJsDestArray, pageNumber: number): DestArray {
         return [
             pageNumber - 1,
             dest[1].name,
@@ -340,9 +328,9 @@ export class PDFPlusLib {
 
     async ensureDestArray(dest: string | DestArray, doc: PDFDocumentProxy) {
         if (typeof dest === 'string') {
-            const destArray = await doc.getDestination(dest) as PDFjsDestArray;
+            const destArray = await doc.getDestination(dest) as PDFJsDestArray;
             if (!destArray) return null;
-            dest = this.normalizePDFjsDestArray(destArray, await doc.getPageIndex(destArray[0]) + 1);
+            dest = this.normalizePDFJsDestArray(destArray, await doc.getPageIndex(destArray[0]) + 1);
         }
 
         return dest;

diff --git a/src/lib/outlines.ts b/src/lib/outlines.ts
@@ -148,7 +148,7 @@ export class PDFOutlines {
                         }
                     } else {
                         const pageNumber = await node.getPageNumber();
-                        if (JSON.stringify(this.lib.normalizePDFjsDestArray(dest, pageNumber)) === JSON.stringify(outlineDest)) {
+                        if (JSON.stringify(this.lib.normalizePDFJsDestArray(dest, pageNumber)) === JSON.stringify(outlineDest)) {
                             found = outlineItem;
                         }
                     }

diff --git a/src/main.ts b/src/main.ts
@@ -87,7 +87,6 @@ export default class PDFPlus extends Plugin {
 
 		await this.loadSettings();
 		await this.saveSettings();
-		this.addSettingTab(this.settingTab = new PDFPlusSettingTab(this));
 
 		this.domManager = this.addChild(new DomManager(this));
 		this.domManager.registerCalloutRenderer();
@@ -111,6 +110,8 @@ export default class PDFPlus extends Plugin {
 		this.startTrackingActiveMarkdownFile();
 
 		this.registerObsidianProtocolHandler('pdf-plus', this.obsidianProtocolHandler.bind(this));
+
+		this.addSettingTab(this.settingTab = new PDFPlusSettingTab(this));
 	}
 
 	async onunload() {
@@ -129,7 +130,7 @@ export default class PDFPlus extends Plugin {
 	}
 
 	private checkVersion() {
-		const untestedVersion = '1.6.3';
+		const untestedVersion = '1.7.0';
 		if (requireApiVersion(untestedVersion)) {
 			console.warn(`${this.manifest.name}: This plugin has not been tested on Obsidian ${untestedVersion} or above. Please report any issue you encounter on GitHub (https://github.com/RyotaUshio/obsidian-pdf-plus/issues/new/choose).`);
 		}

diff --git a/src/patchers/pdf-internals.ts b/src/patchers/pdf-internals.ts
@@ -189,6 +189,19 @@ const patchPDFViewerChild = (plugin: PDFPlus, child: PDFViewerChild) => {
                 addColorPaletteToToolbar();
                 plugin.on('update-dom', addColorPaletteToToolbar);
 
+                // Use !isMobile, not isDesktopApp, because in app.js, PDFViewerChild.onMobileCopy is called when isMobile is true.
+                if (!Platform.isMobile) {
+                    const eventBus = this.pdfViewer.eventBus;
+                    if (eventBus) {
+                        eventBus.on('textlayerrendered', ({ source: pageView }) => {
+                            const textLayerDiv = pageView?.textLayer?.div;
+                            if (textLayerDiv) {
+                                textLayerDiv.addEventListener('copy', onCopy);
+                            }
+                        });
+                    }
+                }
+
                 return ret;
             }
 
@@ -820,6 +833,7 @@ const patchPDFViewerChild = (plugin: PDFPlus, child: PDFViewerChild) => {
             return function (this: PDFViewerChild, evt: ClipboardEvent, pageView: PDFPageView) {
                 switch (plugin.settings.mobileCopyAction) {
                     case 'text':
+                        onCopy(evt);
                         return;
                     case 'pdf-plus':
                         setTimeout(() => lib.commands.copyLink(false));
@@ -839,6 +853,19 @@ const patchPDFViewerChild = (plugin: PDFPlus, child: PDFViewerChild) => {
             }
         }
     }));
+
+    const onCopy = (evt: ClipboardEvent) => {
+        if (!plugin.settings.copyAsSingleLine) return;
+
+        const dataTransfer = evt.clipboardData;
+        if (!dataTransfer) return;
+
+        let text = (evt.target as HTMLElement).win.getSelection()?.toString(); // dataTransfer.getData('text/plain');
+        if (text) {
+            text = lib.toSingleLine(text);
+            dataTransfer.setData('text/plain', text);
+        }
+    };
 }
 
 /** Monkey-patch ObsidianViewer so that it can open external PDF files. */

diff --git a/src/post-process/pdf-link-like.ts b/src/post-process/pdf-link-like.ts
@@ -2,7 +2,7 @@ import { App, HoverParent, HoverPopover, Keymap } from 'obsidian';
 
 import PDFPlus from 'main';
 import { PDFPlusLib } from 'lib';
-import { AnnotationElement, PDFOutlineTreeNode, PDFViewerChild, PDFjsDestArray } from 'typings';
+import { AnnotationElement, PDFOutlineTreeNode, PDFViewerChild, PDFJsDestArray } from 'typings';
 import { isCitationId, isMouseEventExternal, isTargetHTMLElement } from 'utils';
 import { BibliographyManager } from 'bib';
 
@@ -159,7 +159,7 @@ abstract class PDFLinkLikePostProcessor implements HoverParent {
  * The destination can be either a string (a named destination) or an array (an explicit destination).
  */
 abstract class PDFDestinationHolderPostProcessor extends PDFLinkLikePostProcessor {
-    abstract getDest(): string | PDFjsDestArray;
+    abstract getDest(): string | PDFJsDestArray;
 
     async getLinkText(evt: MouseEvent) {
         const { lib, child, targetEl } = this;
@@ -226,7 +226,7 @@ export class PDFInternalLinkPostProcessor extends PDFDestinationHolderPostProces
         return super.getLinkText(evt);
     }
 
-    getDest(): string | PDFjsDestArray {
+    getDest(): string | PDFJsDestArray {
         return this.linkAnnotationElement.data.dest;
     }