Merge pull request #46 from omnivore-app/fix/retrieving-highlights-from-pdf

fix: failed to sort highlights in the file

Author: sywhb

src/index.ts

@@ -6,7 +6,14 @@ import {
   SettingSchemaDesc,
 } from '@logseq/libs/dist/LSPlugin'
 import { getDateForPage } from 'logseq-dateutils'
-import { Article, getHighlightLocation, loadArticles } from './util'
+import {
+  Article,
+  compareHighlightsInFile,
+  getHighlightLocation,
+  getHighlightPoint,
+  loadArticles,
+  PageType,
+} from './util'
 import { DateTime } from 'luxon'
 
 enum Filter {
@@ -160,7 +167,19 @@ const fetchOmnivore = async (inBackground = false) => {
         // sort highlights by location if selected in options
         highlightOrder === HighlightOrder.LOCATION &&
           article.highlights?.sort((a, b) => {
-            return getHighlightLocation(a.patch) - getHighlightLocation(b.patch)
+            try {
+              if (article.pageType === PageType.File) {
+                // sort by location in file
+                return compareHighlightsInFile(a, b)
+              }
+              // for web page, sort by location in the page
+              return (
+                getHighlightLocation(a.patch) - getHighlightLocation(b.patch)
+              )
+            } catch (e) {
+              console.error(e)
+              return compareHighlightsInFile(a, b)
+            }
           })
 
         const highlightBatch = article.highlights?.map((it) => {

src/util.ts

@@ -19,6 +19,16 @@ export interface SearchResponse {
   }
 }
 
+export enum PageType {
+  Article = 'ARTICLE',
+  Book = 'BOOK',
+  File = 'FILE',
+  Profile = 'PROFILE',
+  Unknown = 'UNKNOWN',
+  Website = 'WEBSITE',
+  Highlights = 'HIGHLIGHTS',
+}
+
 export interface Article {
   title: string
   siteName: string
@@ -30,6 +40,7 @@ export interface Article {
   highlights?: Highlight[]
   updatedAt: string
   savedAt: string
+  pageType: PageType
 }
 
 export interface Label {
@@ -43,6 +54,11 @@ export interface Highlight {
   patch: string
 }
 
+export interface HighlightPoint {
+  left: number
+  top: number
+}
+
 const endpoint = 'https://api-prod.omnivore.app/api/graphql'
 
 export const loadArticle = async (
@@ -74,7 +90,7 @@ export const loadArticles = async (
       'content-type': 'application/json',
       authorization: apiKey,
     },
-    body: `{"query":"\\n    query Search($after: String, $first: Int, $query: String) {\\n      search(first: $first, after: $after, query: $query) {\\n        ... on SearchSuccess {\\n          edges {\\n            node {\\n              title\\n              slug\\n              siteName\\n              originalArticleUrl\\n              url\\n              author\\n              updatedAt\\n              description\\n              savedAt\\n            highlights {\\n            id\\n        quote\\n        annotation\\n        patch\\n          }\\n        labels {\\n            name\\n          }\\n            }\\n          }\\n          pageInfo {\\n            hasNextPage\\n          }\\n        }\\n        ... on SearchError {\\n          errorCodes\\n        }\\n      }\\n    }\\n  ","variables":{"after":"${after}","first":${first}, "query":"${
+    body: `{"query":"\\n    query Search($after: String, $first: Int, $query: String) {\\n      search(first: $first, after: $after, query: $query) {\\n        ... on SearchSuccess {\\n          edges {\\n            node {\\n              title\\n              slug\\n              siteName\\n              originalArticleUrl\\n              url\\n              author\\n              updatedAt\\n              description\\n              savedAt\\n            pageType\\n            highlights {\\n            id\\n        quote\\n        annotation\\n        patch\\n          }\\n        labels {\\n            name\\n          }\\n            }\\n          }\\n          pageInfo {\\n            hasNextPage\\n          }\\n        }\\n        ... on SearchError {\\n          errorCodes\\n        }\\n      }\\n    }\\n  ","variables":{"after":"${after}","first":${first}, "query":"${
       updatedAt ? 'updated:' + updatedAt : ''
     } sort:saved-asc ${query}"}}`,
     method: 'POST',
@@ -91,3 +107,23 @@ export const getHighlightLocation = (patch: string): number => {
   const patches = dmp.patch_fromText(patch)
   return patches[0].start1 || 0
 }
+
+export const getHighlightPoint = (patch: string): HighlightPoint => {
+  const { bbox } = JSON.parse(patch) as { bbox: number[] }
+  if (!bbox || bbox.length !== 4) {
+    return { left: 0, top: 0 }
+  }
+  return { left: bbox[0], top: bbox[1] }
+}
+
+export const compareHighlightsInFile = (a: Highlight, b: Highlight): number => {
+  // get the position of the highlight in the file
+  const highlightPointA = getHighlightPoint(a.patch)
+  const highlightPointB = getHighlightPoint(b.patch)
+  if (highlightPointA.top === highlightPointB.top) {
+    // if top is same, sort by left
+    return highlightPointA.left - highlightPointB.left
+  }
+  // sort by top
+  return highlightPointA.top - highlightPointB.top
+}