Merge pull request #38 from omnivore-app/feature/config-enum

Make filter an enum option and add syncAt to settings

Author: sywhb

package.json

@@ -24,13 +24,15 @@
   },
   "dependencies": {
     "@logseq/libs": "^0.0.6",
-    "logseq-dateutils": "^0.0.22"
+    "logseq-dateutils": "^0.0.22",
+    "luxon": "^3.0.1"
   },
   "devDependencies": {
     "@semantic-release/changelog": "^6.0.1",
     "@semantic-release/exec": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
     "@tsconfig/node16": "^1.0.1",
+    "@types/luxon": "^2.3.2",
     "@typescript-eslint/eslint-plugin": "^5.9.0",
     "@typescript-eslint/parser": "^5.9.0",
     "eslint": "^8.6.0",

src/index.ts

@@ -8,6 +8,23 @@ import {
 import { getDateForPage } from 'logseq-dateutils'
 import icon from '../public/icon.png'
 import { Article, loadArticles } from './util'
+import { DateTime } from 'luxon'
+
+enum Filter {
+  ALL = 'import all my articles',
+  HIGHLIGHTS = 'import just highlights',
+  ADVANCED = 'advanced',
+}
+
+interface Settings {
+  apiKey: string
+  filter: Filter
+  syncAt: string
+  frequency: number
+  graph: string
+  customQuery: string
+  disabled: boolean
+}
 
 const siteNameFromUrl = (originalArticleUrl: string): string => {
   try {
@@ -18,20 +35,31 @@ const siteNameFromUrl = (originalArticleUrl: string): string => {
 }
 
 const delay = (t = 100) => new Promise((r) => setTimeout(r, t))
+const DATE_FORMAT = "yyyy-MM-dd'T'HH:mm:ss"
 let loading = false
 
-const fetchOmnivore = async (
-  apiKey: string,
-  filter: string,
-  syncAt: string,
-  inBackground = false
-): Promise<string> => {
-  if (loading) return syncAt
+const getQueryFromFilter = (filter: Filter, customQuery: string): string => {
+  switch (filter) {
+    case Filter.ALL:
+      return ''
+    case Filter.HIGHLIGHTS:
+      return `has:highlights`
+    case Filter.ADVANCED:
+      return customQuery
+    default:
+      return ''
+  }
+}
+
+const fetchOmnivore = async (inBackground = false) => {
+  if (loading) return
+
+  const { syncAt, apiKey, filter, customQuery } = logseq.settings as Settings
 
   if (!apiKey) {
     await logseq.UI.showMsg('Missing Omnivore api key', 'warning')
 
-    return syncAt
+    return
   }
 
   const pageName = 'Omnivore'
@@ -82,8 +110,8 @@ const fetchOmnivore = async (
         apiKey,
         after,
         size,
-        syncAt,
-        filter
+        DateTime.fromFormat(syncAt, DATE_FORMAT).toISO(),
+        getQueryFromFilter(filter, customQuery)
       )
 
       const articleBatch: IBatchBlock[] = []
@@ -146,42 +174,33 @@ const fetchOmnivore = async (
         }))
     }
 
-    syncAt = new Date().toISOString()
     !inBackground && (await logseq.UI.showMsg('🔖 Articles fetched'))
-
-    return syncAt
+    logseq.updateSettings({ syncAt: DateTime.local().toFormat(DATE_FORMAT) })
   } catch (e) {
     !inBackground &&
       (await logseq.UI.showMsg('Failed to fetch articles', 'warning'))
     console.error(e)
-
-    return syncAt
   } finally {
     loading = false
     targetBlock &&
       (await logseq.Editor.updateBlock(targetBlock.uuid, blockTitle))
-    logseq.updateSettings({ 'synced at': syncAt })
   }
 }
 
-const syncOmnivore = (
-  apiKey: string,
-  frequency: number,
-  filter: string,
-  syncAt: string,
-  graph: string
-): number => {
+const syncOmnivore = (): number => {
+  const settings = logseq.settings as Settings
+
   let intervalID = 0
   // sync every frequency minutes
-  if (frequency > 0) {
+  if (settings.frequency > 0) {
     intervalID = setInterval(
       async () => {
-        if ((await logseq.App.getCurrentGraph())?.name === graph) {
-          syncAt = await fetchOmnivore(apiKey, filter, syncAt, true)
+        if ((await logseq.App.getCurrentGraph())?.name === settings.graph) {
+          await fetchOmnivore(true)
         }
       },
-      frequency * 1000 * 60,
-      syncAt
+      settings.frequency * 1000 * 60,
+      settings.syncAt
     )
   }
 
@@ -195,21 +214,30 @@ const syncOmnivore = (
 const main = async (baseInfo: LSPluginBaseInfo) => {
   console.log('logseq-omnivore loaded')
 
-  const settings: SettingSchemaDesc[] = [
+  const settingsSchema: SettingSchemaDesc[] = [
     {
-      key: 'api key',
+      key: 'apiKey',
       type: 'string',
       title: 'Enter Omnivore Api Key',
       description: 'Enter Omnivore Api Key here',
-      default: '',
+      default: logseq.settings?.['api key'] as string,
     },
     {
       key: 'filter',
+      type: 'enum',
+      title: 'Select a filter for Omnivore articles',
+      description: 'Select a filter for Omnivore articles',
+      default: Filter.HIGHLIGHTS.toString(),
+      enumPicker: 'select',
+      enumChoices: Object.values(Filter),
+    },
+    {
+      key: 'customQuery',
       type: 'string',
-      title: 'Enter a filter for Omnivore articles',
+      title: 'Enter custom query if advanced filter is selected',
       description:
-        'Enter a filter for Omnivore articles here. e.g. "has:highlights"',
-      default: 'has:highlights',
+        'Enter a custom query for Omnivore articles here. e.g. "has:highlights"',
+      default: '',
     },
     {
       key: 'frequency',
@@ -227,35 +255,41 @@ const main = async (baseInfo: LSPluginBaseInfo) => {
       // default is the current graph
       default: (await logseq.App.getCurrentGraph())?.name as string,
     },
+    {
+      key: 'syncAt',
+      type: 'string',
+      title: 'Last Sync',
+      description:
+        'The last time Omnivore was synced. Clear this value to completely refresh the sync.',
+      default: DateTime.fromISO(logseq.settings?.['synced at'] as string)
+        .toLocal()
+        .toFormat(DATE_FORMAT),
+      inputAs: 'datetime-local',
+    },
   ]
-  logseq.useSettingsSchema(settings)
+  logseq.useSettingsSchema(settingsSchema)
 
-  let apiKey = logseq.settings?.['api key'] as string
   let frequency = logseq.settings?.frequency as number
-  let filter = logseq.settings?.filter as string
-  let syncAt = logseq.settings?.['synced at'] as string
   let intervalID: number
-  let graph = logseq.settings?.graph as string
 
   logseq.onSettingsChanged(() => {
-    apiKey = logseq.settings?.['api key'] as string
-    filter = logseq.settings?.filter as string
-    syncAt = logseq.settings?.['synced at'] as string
-    graph = logseq.settings?.graph as string
-    // remove existing scheduled task and create new one
-    const newFrequency = logseq.settings?.frequency as number
+    const settings = logseq.settings as Settings
+    const newFrequency = settings.frequency
     if (newFrequency !== frequency) {
+      // remove existing scheduled task and create new one
       if (intervalID) {
         clearInterval(intervalID)
       }
+      if (newFrequency > 0) {
+        intervalID = syncOmnivore()
+      }
       frequency = newFrequency
-      intervalID = syncOmnivore(apiKey, frequency, filter, syncAt, graph)
     }
   })
 
   logseq.provideModel({
     async loadOmnivore() {
-      await fetchOmnivore(apiKey, filter, syncAt)
+      await fetchOmnivore()
     },
   })
 
@@ -276,10 +310,10 @@ const main = async (baseInfo: LSPluginBaseInfo) => {
   `)
 
   // fetch articles on startup
-  await fetchOmnivore(apiKey, filter, syncAt, true)
+  await fetchOmnivore(true)
 
   // sync every frequency minutes
-  intervalID = syncOmnivore(apiKey, frequency, filter, syncAt, graph)
+  intervalID = syncOmnivore()
 }
 
 // bootstrap

src/util.ts

@@ -64,7 +64,7 @@ export const loadArticles = async (
   after = 0,
   first = 10,
   updatedAt = '',
-  filter = ''
+  query = ''
 ): Promise<[Article[], boolean]> => {
   const res = await fetch(endpoint, {
     headers: {
@@ -73,7 +73,7 @@ export const loadArticles = async (
     },
     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          }\\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 ${filter}"}}`,
+    } sort:saved-asc ${query}"}}`,
     method: 'POST',
   })
 

yarn.lock

@@ -1210,6 +1210,11 @@
   resolved "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.11.tgz"
   integrity sha512-wOuvG1SN4Us4rez+tylwwwCV1psiNVOkJeM3AUWUNWg/jDQY2+HE/444y5gc+jBmRqASOm2Oeh5c1axHobwRKQ==
 
+"@types/luxon@^2.3.2":
+  version "2.3.2"
+  resolved "https://registry.yarnpkg.com/@types/luxon/-/luxon-2.3.2.tgz#8a3f2cdd4858ce698b56cd8597d9243b8e9d3c65"
+  integrity sha512-WOehptuhKIXukSUUkRgGbj2c997Uv/iUgYgII8U7XLJqq9W2oF0kQ6frEznRQbdurioz+L/cdaIm4GutTQfgmA==
+
 "@types/minimist@^1.2.0":
   version "1.2.2"
   resolved "https://registry.npmjs.org/@types/minimist/-/minimist-1.2.2.tgz"
@@ -3202,6 +3207,11 @@ lru-cache@^7.4.4, lru-cache@^7.5.1, lru-cache@^7.7.1:
   resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-7.12.0.tgz#be2649a992c8a9116efda5c487538dcf715f3476"
   integrity sha512-OIP3DwzRZDfLg9B9VP/huWBlpvbkmbfiBy8xmsXp4RPmE4A3MhwNozc5ZJ3fWnSg8fDcdlE/neRTPG2ycEKliw==
 
+luxon@^3.0.1:
+  version "3.0.1"
+  resolved "https://registry.yarnpkg.com/luxon/-/luxon-3.0.1.tgz#6901111d10ad06fd267ad4e4128a84bef8a77299"
+  integrity sha512-hF3kv0e5gwHQZKz4wtm4c+inDtyc7elkanAsBq+fundaCdUBNJB1dHEGUZIM6SfSBUlbVFduPwEtNjFK8wLtcw==
+
 make-fetch-happen@^10.0.3, make-fetch-happen@^10.0.6, make-fetch-happen@^10.1.8:
   version "10.1.8"
   resolved "https://registry.npmjs.org/make-fetch-happen/-/make-fetch-happen-10.1.8.tgz"