Adding support for syncing a particular Pocket tag only (#68)

README.md

@@ -34,6 +34,11 @@ within Obsidian.
 
 You can also sync your Pocket items using an Obsidian command: "Sync Pocket list".
 
+You can either sync all Pocket items or just Pocket items with a particular tag
+that you specify, using the "Pocket sync tag" setting. Leave it blank to sync
+all Pocket items, or specify a Pocket tag to limit your sync to just Pocket
+items with that tag.
+
 ### Opening and using the Pocket list
 
 Once the Pocket list is downloaded and stored, open the command palette and

src/SettingsManager.ts

@@ -1,5 +1,4 @@
 import update from "immutability-helper";
-import log from "loglevel";
 import { MultiWordTagConversion } from "./Tags";
 import { CallbackId, CallbackRegistry } from "./Types";
 import { getUniqueId } from "./utils";
@@ -8,6 +7,7 @@ export interface PocketSettings {
   "item-note-template"?: string;
   "item-notes-folder"?: string;
   "multi-word-tag-converter"?: MultiWordTagConversion;
+  "pocket-sync-tag"?: string;
 }
 
 const DEFAULT_POCKET_SETTINGS: PocketSettings = {

src/data/PocketSync.ts

@@ -6,15 +6,17 @@ import { PocketItemStore } from "./PocketItemStore";
 export const doPocketSync = async (
   itemStore: PocketItemStore,
   pocketAPI: PocketAPI,
-  accessInfo: AccessInfo
+  accessInfo: AccessInfo,
+  pocketSyncTag?: string
 ) => {
   const lastUpdateTimestamp = await itemStore.getLastUpdateTimestamp();
 
   new Notice(`Fetching Pocket updates for ${accessInfo.username}`);
 
   const getPocketItemsResponse = await pocketAPI.getPocketItems(
     accessInfo.accessToken,
-    lastUpdateTimestamp
+    lastUpdateTimestamp,
+    pocketSyncTag
   );
 
   new Notice(

src/main.ts

@@ -48,7 +48,13 @@ export default class PocketSync extends Plugin {
       return;
     }
 
-    this.pendingSync = doPocketSync(this.itemStore, this.pocketAPI, accessInfo);
+    const pocketSyncTag = this.settingsManager.getSetting("pocket-sync-tag");
+    this.pendingSync = doPocketSync(
+      this.itemStore,
+      this.pocketAPI,
+      accessInfo,
+      pocketSyncTag
+    );
     try {
       await this.pendingSync;
     } finally {

src/pocket_api/PocketAPI.ts

@@ -53,7 +53,8 @@ export type GetRequestToken = (
 export type GetAccessToken = () => Promise<AccessTokenResponse>;
 export type GetPocketItems = (
   accessToken: AccessToken,
-  lastUpdateTimestamp?: UpdateTimestamp
+  lastUpdateTimestamp?: UpdateTimestamp,
+  pocketSyncTag?: string
 ) => Promise<TimestampedPocketGetItemsResponse>;
 
 export interface PocketAPI {
@@ -120,7 +121,8 @@ export type TimestampedPocketGetItemsResponse = {
 
 export const getPocketItems: GetPocketItems = async (
   accessToken,
-  lastUpdateTimestamp?
+  lastUpdateTimestamp?,
+  pocketSyncTag?
 ) => {
   const GET_ITEMS_URL = "https://getpocket.com/v3/get";
   const nextTimestamp = Math.floor(Date.now() / 1000);
@@ -132,6 +134,7 @@ export const getPocketItems: GetPocketItems = async (
       ? new Number(lastUpdateTimestamp).toString()
       : null,
     detailType: "complete",
+    tag: pocketSyncTag,
   };
 
   if (!!lastUpdateTimestamp) {

src/ui/settings.ts

@@ -158,6 +158,27 @@ const addMultiWordTagConverterSetting = (
     });
 };
 
+const SYNC_TAG_CTA = "Pocket sync tag";
+const SYNC_TAG_DESC = `Specify a Pocket tag to sync, e.g. adding 'obsidian' here
+will result in only Pocket items tagged with 'obsidian' being synced. If this
+setting is left blank, all Pocket items will be synced.`;
+
+const addPocketSyncTagSetting = (
+  settingsManager: SettingsManager,
+  containerEl: HTMLElement
+) => {
+  new Setting(containerEl)
+    .setName(SYNC_TAG_CTA)
+    .setDesc(SYNC_TAG_DESC)
+    .addText((text) => {
+      text.setPlaceholder("Specify a tag to limit syncs");
+      text.setValue(settingsManager.getSetting("pocket-sync-tag"));
+      text.onChange(async (newValue) => {
+        await settingsManager.updateSetting("pocket-sync-tag", newValue);
+      });
+    });
+};
+
 export class PocketSettingTab extends PluginSettingTab {
   plugin: PocketSync;
   settingsManager: SettingsManager;
@@ -178,5 +199,6 @@ export class PocketSettingTab extends PluginSettingTab {
     addItemNoteTemplateSetting(this.settingsManager, containerEl);
     addItemNotesLocationSetting(this.settingsManager, containerEl);
     addMultiWordTagConverterSetting(this.settingsManager, containerEl);
+    addPocketSyncTagSetting(this.settingsManager, containerEl);
   }
 }