v0.0.15

Author: kaiiiz

manifest.json

@@ -1,7 +1,7 @@
 {
 	"id": "obsidian-raindrop-highlights",
 	"name": "Raindrop Highlights",
-	"version": "0.0.14",
+	"version": "0.0.15",
 	"minAppVersion": "0.14.0",
 	"description": "Sync your Raindrop.io highlights.",
 	"author": "kaiiiz",

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "obsidian-raindrop-highlights",
-	"version": "0.0.14",
+	"version": "0.0.15",
 	"description": "Sync your Raindrop.io highlights.",
 	"main": "main.js",
 	"scripts": {

src/api.ts

@@ -181,6 +181,10 @@ export class RaindropAPI {
 			created: new Date(raindrop['created']),
 			type: raindrop['type'],
 			important: raindrop['important'],
+			creator: {
+				name: raindrop['creatorRef']['name'],
+				id: raindrop['creatorRef']['_id'],
+			},
 		};
 		return bookmark;
 	}

src/assets/defaultTemplate.njk

@@ -22,6 +22,6 @@
 > [!{{callout}}]+ Updated on {{highlight.lastUpdate}}
 >
 > {{highlight.text.split("\n") | join("\n>")}}
-{% if highlight.note -%}> > {{highlight.note}}{%- endif %}
+{% if highlight.note -%}> > {{highlight.note + "\n"}}{%- endif %}
 
 {%- endfor -%}

src/constants.ts

@@ -1,14 +1,15 @@
 import DEFAULT_TEMPLATE from './assets/defaultTemplate.njk';
 import type { RaindropPluginSettings } from "./types";
 
-export const VERSION = '0.0.14';
+export const VERSION = '0.0.15';
 
 export const DEFAULT_SETTINGS: RaindropPluginSettings = {
 	version: VERSION,
 	username: undefined,
 	isConnected: false,
 	ribbonIcon: true,
 	appendMode: true,
+	collectionsFolders: true,
 	onlyBookmarksWithHl: false,
 	highlightsFolder: '/',
 	syncCollections: {},

src/main.ts

@@ -69,6 +69,10 @@ export default class RaindropPlugin extends Plugin {
 		});
 
 		this.addSettingTab(new RaindropSettingTab(this.app, this, this.api));
+
+		if (this.settings.autoSyncInterval) {
+			this.startAutoSync();
+		}
 	}
 
 	async onunload() {

src/renderer.ts

@@ -17,6 +17,11 @@ type RenderCollection = {
 	title: string;
 };
 
+type RenderCreator = {
+	name: string,
+	id: number,
+};
+
 type RenderTemplate = {
 	is_new_article: boolean;
 	id: number;
@@ -30,6 +35,7 @@ type RenderTemplate = {
 	created: string;
 	type: string;
 	important: boolean;
+	creator: RenderCreator;
 };
 
 const FAKE_RENDER_CONTEXT: RenderTemplate = {
@@ -56,6 +62,10 @@ const FAKE_RENDER_CONTEXT: RenderTemplate = {
 	created: "2022-08-10T01:58:27.457Z",
 	type: "link",
 	important: false,
+	creator: {
+		name: 'fake_name',
+		id: 10000,
+	}
 };
 
 export default class Renderer {
@@ -86,20 +96,7 @@ export default class Renderer {
 
 	renderFrontmatter(bookmark: RaindropBookmark, newArticle: boolean) {
 		const newMdFrontmatter = this.renderTemplate(this.plugin.settings.metadataTemplate, bookmark, newArticle);
-		let frontmatter: BookmarkFileFrontMatter = {
-			raindrop_id: bookmark.id,
-			raindrop_last_update: (new Date()).toISOString(),
-		};
-		try {
-			frontmatter = {
-				...frontmatter,
-				...parseYaml(newMdFrontmatter),
-			};
-		} catch (e) {
-			console.error(e);
-			new Notice(`Failed to parse YAML for ${bookmark.title}: ${e.message}`)
-		}
-		return stringifyYaml(frontmatter);
+		return `raindrop_id: ${bookmark.id}\nraindrop_last_update: ${(new Date()).toISOString()}\n${newMdFrontmatter}\n`
 	}
 
 	renderFullArticle(bookmark: RaindropBookmark) {
@@ -142,6 +139,7 @@ export default class Renderer {
 			created: Moment(bookmark.created).format(dateTimeFormat),
 			type: bookmark.type,
 			important: bookmark.important,
+			creator: bookmark.creator,
 		};
 
 		const content = nunjucks.renderString(template, context);

src/settings.ts

@@ -34,6 +34,7 @@ export class RaindropSettingTab extends PluginSettingTab {
 		this.ribbonIcon();
 		this.onlyBookmarksWithHl();
 		this.appendMode();
+		this.collectionsFolders();
 		this.highlightsFolder();
 		this.collections();
 		this.autoSyncInterval();
@@ -87,6 +88,19 @@ export class RaindropSettingTab extends PluginSettingTab {
 			});
 	}
 
+	private collectionsFolders(): void {
+		new Setting(this.containerEl)
+			.setName('Store the articles in collections folders')
+			.addToggle((toggle) => {
+				return toggle
+					.setValue(this.plugin.settings.collectionsFolders)
+					.onChange(async (value) => {
+						this.plugin.settings.collectionsFolders = value;
+						await this.plugin.saveSettings();
+					});
+			});
+	}
+
 	private connect(): void {
 		new Setting(this.containerEl)
 			.setName('Connect to Raindrop.io')

src/sync.ts

@@ -33,7 +33,10 @@ export default class RaindropSync {
 	async syncCollection(collection: SyncCollection) {
 		new Notice(`Sync Raindrop collection: ${collection.title}`);
 		const highlightsFolder = this.plugin.settings.highlightsFolder;
-		const collectionFolder = `${highlightsFolder}/${collection["title"]}`;
+		let collectionFolder = `${highlightsFolder}`
+		if (this.plugin.settings.collectionsFolders) {
+			collectionFolder = `${highlightsFolder}/${collection["title"]}`;
+		}
 		const lastSyncDate = this.plugin.settings.syncCollections[collection.id].lastSyncDate;
 
 		let bookmarks: RaindropBookmark[] = [];
@@ -49,6 +52,15 @@ export default class RaindropSync {
 	}
 
 	async syncBookmarks(bookmarks: RaindropBookmark[], folderPath: string) {
+		if (bookmarks.length == 0) return;
+
+		if (this.plugin.settings.onlyBookmarksWithHl) {
+			let requireUpdate = bookmarks.some((bookmark) => {
+				return bookmark.highlights.length != 0;
+			});
+			if (!requireUpdate) return;
+		}
+
 		try {
 			await this.app.vault.createFolder(folderPath);
 		} catch (e) {

src/templates/templateInstructions.html

@@ -12,14 +12,22 @@
   <li><span class="u-pop">{{title}}</span> (string) - Title</li>
   <li><span class="u-pop">{{excerpt}}</span> (string) - Article excerpt</li>
   <li><span class="u-pop">{{link}}</span> (string) - Link to source</li>
-  <li><span class="u-pop">{{highlights}}</span> (string) - List of your Highlights</li>
+  <li><span class="u-pop">{{highlights}}</span> (Highlight[]) - List of your Highlights (Detail attributes refer to the following <span class="u-pop">Highlight</span> section)</li>
+  <li><span class="u-pop">{{collection}}</span> (Collection) - Collection data (Detail attributes refer to the following <span class="u-pop">Collection</span> section</li>
+  <li><span class="u-pop">{{creator}}</span> (Creator) - Creator data (Detail attributes refer to the following <span class="u-pop">Creator</span> section</li>
   <li><span class="u-pop">{{tags}}</span> (string) - List of tag</li>
   <li><span class="u-pop">{{cover}}</span> (string) - Article cover</li>
   <li><span class="u-pop">{{created}}</span> (string) - Created on</li>
   <li><span class="u-pop">{{type}}</span> (string) - Article type</li>
   <li><span class="u-pop">{{important}}</span> (bool) - Favorite article</li>
 </ul>
 
+Creator
+<ul>
+  <li><span class="u-pop">{{name}}</span> (string) - Creator name</li>
+  <li><span class="u-pop">{{id}}</span> (number) - Creator id</li>
+</ul>
+
 Collection
 <ul>
   <li><span class="u-pop">{{title}}</span> (string) - Collection title</li>

src/types.ts

@@ -18,6 +18,11 @@ export interface RaindropHighlight { // Remote state
 	text: string,
 }
 
+export interface RaindropCreatorRef { // Remote state
+	name: string,
+	id: number,
+};
+
 export interface RaindropBookmark { // Remote state
 	id: number,
 	collectionId: number,
@@ -31,6 +36,7 @@ export interface RaindropBookmark { // Remote state
 	created: Date,
 	type: string,
 	important: boolean,
+	creator: RaindropCreatorRef,
 }
 
 // ----------
@@ -63,6 +69,7 @@ export interface RaindropPluginSettings {
 	isConnected: boolean;
 	ribbonIcon: boolean;
 	appendMode: boolean;
+	collectionsFolders: boolean;
 	onlyBookmarksWithHl: boolean;
 	highlightsFolder: string;
 	syncCollections: SyncCollectionSettings;

versions.json

@@ -12,5 +12,6 @@
 	"0.0.11": "0.14.0",
 	"0.0.12": "0.14.0",
 	"0.0.13": "0.14.0",
-	"0.0.14": "0.14.0"
+	"0.0.14": "0.14.0",
+	"0.0.15": "0.14.0"
 }