feat: add apple books highlight links #24
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| ALTER TABLE ZAEANNOTATION ADD `ZANNOTATIONLOCATION` text; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| { | ||
| "version": "5", | ||
| "dialect": "sqlite", | ||
| "id": "7be16a02-e20b-4725-898a-4f88e7a3bf1a", | ||
| "prevId": "9ab8f1f7-710a-4b2c-9ba7-b286cb403847", | ||
| "tables": { | ||
| "ZAEANNOTATION": { | ||
| "name": "ZAEANNOTATION", | ||
| "columns": { | ||
| "ZANNOTATIONASSETID": { | ||
| "name": "ZANNOTATIONASSETID", | ||
| "type": "text", | ||
| "primaryKey": false, | ||
| "notNull": false, | ||
| "autoincrement": false | ||
| }, | ||
| "ZFUTUREPROOFING5": { | ||
| "name": "ZFUTUREPROOFING5", | ||
| "type": "text", | ||
| "primaryKey": false, | ||
| "notNull": false, | ||
| "autoincrement": false | ||
| }, | ||
| "ZANNOTATIONREPRESENTATIVETEXT": { | ||
| "name": "ZANNOTATIONREPRESENTATIVETEXT", | ||
| "type": "text", | ||
| "primaryKey": false, | ||
| "notNull": false, | ||
| "autoincrement": false | ||
| }, | ||
| "ZANNOTATIONSELECTEDTEXT": { | ||
| "name": "ZANNOTATIONSELECTEDTEXT", | ||
| "type": "text", | ||
| "primaryKey": false, | ||
| "notNull": true, | ||
| "autoincrement": false | ||
| }, | ||
| "ZANNOTATIONLOCATION": { | ||
| "name": "ZANNOTATIONLOCATION", | ||
| "type": "text", | ||
| "primaryKey": false, | ||
| "notNull": false, | ||
| "autoincrement": false | ||
| }, | ||
| "ZANNOTATIONNOTE": { | ||
| "name": "ZANNOTATIONNOTE", | ||
| "type": "text", | ||
| "primaryKey": false, | ||
| "notNull": false, | ||
| "autoincrement": false | ||
| }, | ||
| "ZANNOTATIONCREATIONDATE": { | ||
| "name": "ZANNOTATIONCREATIONDATE", | ||
| "type": "integer", | ||
| "primaryKey": false, | ||
| "notNull": false, | ||
| "autoincrement": false | ||
| }, | ||
| "ZANNOTATIONMODIFICATIONDATE": { | ||
| "name": "ZANNOTATIONMODIFICATIONDATE", | ||
| "type": "integer", | ||
| "primaryKey": false, | ||
| "notNull": false, | ||
| "autoincrement": false | ||
| }, | ||
| "ZANNOTATIONSTYLE": { | ||
| "name": "ZANNOTATIONSTYLE", | ||
| "type": "integer", | ||
| "primaryKey": false, | ||
| "notNull": false, | ||
| "autoincrement": false | ||
| }, | ||
| "ZANNOTATIONDELETED": { | ||
| "name": "ZANNOTATIONDELETED", | ||
| "type": "integer", | ||
| "primaryKey": false, | ||
| "notNull": false, | ||
| "autoincrement": false | ||
| } | ||
| }, | ||
| "indexes": {}, | ||
| "foreignKeys": {}, | ||
| "compositePrimaryKeys": {}, | ||
| "uniqueConstraints": {} | ||
| }, | ||
| "ZBKLIBRARYASSET": { | ||
| "name": "ZBKLIBRARYASSET", | ||
| "columns": { | ||
| "ZASSETID": { | ||
| "name": "ZASSETID", | ||
| "type": "text", | ||
| "primaryKey": false, | ||
| "notNull": false, | ||
| "autoincrement": false | ||
| }, | ||
| "ZTITLE": { | ||
| "name": "ZTITLE", | ||
| "type": "text", | ||
| "primaryKey": false, | ||
| "notNull": false, | ||
| "autoincrement": false | ||
| }, | ||
| "ZAUTHOR": { | ||
| "name": "ZAUTHOR", | ||
| "type": "text", | ||
| "primaryKey": false, | ||
| "notNull": false, | ||
| "autoincrement": false | ||
| }, | ||
| "ZGENRE": { | ||
| "name": "ZGENRE", | ||
| "type": "text", | ||
| "primaryKey": false, | ||
| "notNull": false, | ||
| "autoincrement": false | ||
| }, | ||
| "ZLANGUAGE": { | ||
| "name": "ZLANGUAGE", | ||
| "type": "text", | ||
| "primaryKey": false, | ||
| "notNull": false, | ||
| "autoincrement": false | ||
| }, | ||
| "ZLASTOPENDATE": { | ||
| "name": "ZLASTOPENDATE", | ||
| "type": "integer", | ||
| "primaryKey": false, | ||
| "notNull": false, | ||
| "autoincrement": false | ||
| }, | ||
| "ZCOVERURL": { | ||
| "name": "ZCOVERURL", | ||
| "type": "text", | ||
| "primaryKey": false, | ||
| "notNull": false, | ||
| "autoincrement": false | ||
| } | ||
| }, | ||
| "indexes": {}, | ||
| "foreignKeys": {}, | ||
| "compositePrimaryKeys": {}, | ||
| "uniqueConstraints": {} | ||
| } | ||
| }, | ||
| "enums": {}, | ||
| "_meta": { | ||
| "schemas": {}, | ||
| "tables": {}, | ||
| "columns": {} | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,6 +8,13 @@ | |
| "when": 1713726520358, | ||
| "tag": "0000_outstanding_wolf_cub", | ||
| "breakpoints": true | ||
| }, | ||
| { | ||
| "idx": 1, | ||
| "version": "5", | ||
| "when": 1720316159179, | ||
| "tag": "0001_misty_silver_centurion", | ||
| "breakpoints": true | ||
| } | ||
| ] | ||
| } | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,6 +19,7 @@ export const HIGHLIGHTS_LIBRARY_COLUMNS = [ | |
| 'ZFUTUREPROOFING5', | ||
| 'ZANNOTATIONREPRESENTATIVETEXT', | ||
| 'ZANNOTATIONSELECTEDTEXT', | ||
| 'ZANNOTATIONLOCATION', | ||
| 'ZANNOTATIONNOTE', | ||
| 'ZANNOTATIONCREATIONDATE', | ||
| 'ZANNOTATIONMODIFICATIONDATE', | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,6 +17,7 @@ export const annotations = sqliteTable(HIGHLIGHTS_LIBRARY_NAME, { | |
| ZFUTUREPROOFING5: text('ZFUTUREPROOFING5'), | ||
| ZANNOTATIONREPRESENTATIVETEXT: text('ZANNOTATIONREPRESENTATIVETEXT'), | ||
| ZANNOTATIONSELECTEDTEXT: text('ZANNOTATIONSELECTEDTEXT').notNull(), | ||
| ZANNOTATIONLOCATION: text('ZANNOTATIONLOCATION'), | ||
| ZANNOTATIONNOTE: text('ZANNOTATIONNOTE'), | ||
| ZANNOTATIONCREATIONDATE: integer('ZANNOTATIONCREATIONDATE'), | ||
| ZANNOTATIONMODIFICATIONDATE: integer('ZANNOTATIONMODIFICATIONDATE'), | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -35,79 +35,87 @@ export const defaultBooks = [{ | |
| export const defaultAnnotations = [{ | ||
| "ZANNOTATIONASSETID": "THBFYNJKTGFTTVCGSAE1", | ||
| "ZFUTUREPROOFING5": "Introduction", | ||
| "ZANNOTATIONREPRESENTATIVETEXT": "This is a contextual text for the highlight from the iPhone User Guide", | ||
| "ZANNOTATIONSELECTEDTEXT": "highlight from the iPhone User Guide", | ||
| "ZANNOTATIONLOCATION": "test-highlight-link-from-the-iphone-user-guide", | ||
| "ZANNOTATIONNOTE": "Test note for the highlight from the iPhone User Guide", | ||
| "ZANNOTATIONCREATIONDATE": 685151385.91602, | ||
| "ZANNOTATIONMODIFICATIONDATE": 685151385.91602, | ||
| "ZANNOTATIONSTYLE": 3, | ||
| "ZANNOTATIONDELETED": 0 | ||
| }, { | ||
| "ZANNOTATIONASSETID": "THBFYNJKTGFTTVCGSAE2", | ||
| "ZFUTUREPROOFING5": "Introduction", | ||
| "ZANNOTATIONREPRESENTATIVETEXT": "This is a contextual text for the highlight from the iPad User Guide", | ||
| "ZANNOTATIONSELECTEDTEXT": "highlight from the iPad User Guide", | ||
| "ZANNOTATIONLOCATION": "test-highlight-link-from-the-ipad-user-guide", | ||
| "ZANNOTATIONNOTE": "Test note for the highlight from the iPad User Guide", | ||
| "ZANNOTATIONCREATIONDATE": 685151385.91602, | ||
| "ZANNOTATIONMODIFICATIONDATE": 685151385.91602, | ||
| "ZANNOTATIONSTYLE": 3, | ||
| "ZANNOTATIONDELETED": 0 | ||
| }, { | ||
| "ZANNOTATIONASSETID": "THBFYNJKTGFTTVCGSAE3", | ||
| "ZFUTUREPROOFING5": "Introduction", | ||
| "ZANNOTATIONREPRESENTATIVETEXT": "This is a contextual text for the highlight from the Mac User Guide", | ||
| "ZANNOTATIONSELECTEDTEXT": "highlight from the Mac User Guide", | ||
| "ZANNOTATIONLOCATION": "test-highlight-link-from-the-mac-user-guide", | ||
| "ZANNOTATIONNOTE": "Test note for the highlight from the Mac User Guide", | ||
| "ZANNOTATIONCREATIONDATE": 685151385.91602, | ||
| "ZANNOTATIONMODIFICATIONDATE": 685151385.91602, | ||
| "ZANNOTATIONSTYLE": 3, | ||
| "ZANNOTATIONDELETED": 0 | ||
| }, { | ||
| "ZANNOTATIONASSETID": "THBFYNJKTGFTTVCGSAE4", | ||
| "ZFUTUREPROOFING5": "Introduction", | ||
| "ZANNOTATIONREPRESENTATIVETEXT": "This is a contextual text for the highlight from the Apple Watch User Guide", | ||
| "ZANNOTATIONSELECTEDTEXT": "highlight from the Apple Watch User Guide", | ||
| "ZANNOTATIONLOCATION": "test-highlight-link-from-the-apple-watch-user-guide", | ||
| "ZANNOTATIONNOTE": "Test note for the highlight from the Apple Watch User Guide", | ||
| "ZANNOTATIONCREATIONDATE": 685151385.91602, | ||
| "ZANNOTATIONMODIFICATIONDATE": 685151385.91602, | ||
| "ZANNOTATIONSTYLE": 3, | ||
| "ZANNOTATIONDELETED": 0 | ||
| }, { | ||
| "ZANNOTATIONASSETID": "THBFYNJKTGFTTVCGSAE1", | ||
| "ZFUTUREPROOFING5": "Introduction", | ||
| "ZANNOTATIONREPRESENTATIVETEXT": "This is a contextual text for the highlight from the iPhone User Guide", | ||
| "ZANNOTATIONSELECTEDTEXT": "highlight from the iPhone User Guide", | ||
| "ZANNOTATIONLOCATION": "test-highlight-link-from-the-iphone-user-guide", | ||
| "ZANNOTATIONNOTE": "Test note for the deleted highlight from the iPhone User Guide", | ||
| "ZANNOTATIONCREATIONDATE": 685151385.91602, | ||
| "ZANNOTATIONMODIFICATIONDATE": 685151385.91602, | ||
| "ZANNOTATIONSTYLE": 3, | ||
| "ZANNOTATIONDELETED": 1 | ||
| }, { | ||
| "ZANNOTATIONASSETID": "THBFYNJKTGFTTVCGSAE2", | ||
| "ZFUTUREPROOFING5": "Introduction", | ||
| "ZANNOTATIONREPRESENTATIVETEXT": "This is a contextual text for the highlight from the iPad User Guide", | ||
| "ZANNOTATIONSELECTEDTEXT": "highlight from the iPad User Guide", | ||
| "ZANNOTATIONLOCATION": "test-highlight-link-from-the-ipad-user-guide", | ||
| "ZANNOTATIONNOTE": "Test note for the deleted highlight from the iPad User Guide", | ||
| "ZANNOTATIONCREATIONDATE": 685151385.91602, | ||
| "ZANNOTATIONMODIFICATIONDATE": 685151385.91602, | ||
| "ZANNOTATIONSTYLE": 3, | ||
| "ZANNOTATIONDELETED": 1 | ||
| }, { | ||
| "ZANNOTATIONASSETID": "THBFYNJKTGFTTVCGSAE3", | ||
| "ZFUTUREPROOFING5": "Introduction", | ||
| "ZANNOTATIONREPRESENTATIVETEXT": "This is a contextual text for the highlight from the Mac User Guide", | ||
| "ZANNOTATIONSELECTEDTEXT": "highlight from the Mac User Guide", | ||
| "ZANNOTATIONLOCATION": "test-highlight-link-from-the-mac-user-guide", | ||
| "ZANNOTATIONNOTE": "Test note for the deleted highlight from the Mac User Guide", | ||
| "ZANNOTATIONCREATIONDATE": 685151385.91602, | ||
| "ZANNOTATIONMODIFICATIONDATE": 685151385.91602, | ||
| "ZANNOTATIONSTYLE": 3, | ||
| "ZANNOTATIONDELETED": 1 | ||
| }, { | ||
| "ZANNOTATIONASSETID": "THBFYNJKTGFTTVCGSAE4", | ||
| "ZFUTUREPROOFING5": "Introduction", | ||
| "ZANNOTATIONREPRESENTATIVETEXT": "This is a contextual text for the highlight from the Apple Watch User Guide", | ||
| "ZANNOTATIONSELECTEDTEXT": "highlight from the Apple Watch User Guide", | ||
| "ZANNOTATIONLOCATION": "test-highlight-link-from-the-apple-watch-user-guide", | ||
| "ZANNOTATIONNOTE": "Test note for the deleted highlight from the Apple Watch User Guide", | ||
| "ZANNOTATIONCREATIONDATE": 685151385.91602, | ||
| "ZANNOTATIONMODIFICATIONDATE": 685151385.91602, | ||
| "ZANNOTATIONSTYLE": 3, | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -30,9 +30,10 @@ export const aggregateBookAndHighlightDetails = async (): Promise<ICombinedBooks | |
|
|
||
| return { | ||
| chapter: annotation.ZFUTUREPROOFING5, | ||
| contextualText: textForContext ? removeAllLastNewlines(preserveNewlineIndentation(textForContext)) : textForContext, | ||
| highlight: removeAllLastNewlines(preserveNewlineIndentation(annotation.ZANNOTATIONSELECTEDTEXT)), | ||
| note: userNote ? removeAllLastNewlines(preserveNewlineIndentation(userNote)) : userNote, | ||
| highlightLocation: annotation.ZANNOTATIONLOCATION, | ||
| highlightStyle: annotation.ZANNOTATIONSTYLE, | ||
| highlightCreationDate: annotation.ZANNOTATIONCREATIONDATE, | ||
| highlightModificationDate: annotation.ZANNOTATIONMODIFICATIONDATE | ||
|
|
@@ -53,3 +54,10 @@ const preserveNewlineIndentation = (textBlock: string): string => { | |
|
|
||
| return stringWithNewLines.test(textBlock) ? textBlock.replace(stringWithNewLines, '\n') : textBlock; | ||
| } | ||
|
|
||
| // Handler of all new line characters (\n) at the end of text blocks to prevent new lines appearing at the end of text blocks | ||
| const removeAllLastNewlines = (textBlock: string): string => { | ||
| const stringAllLastNewLines = /\n+$/; | ||
|
|
||
| return stringAllLastNewLines.test(textBlock) ? textBlock.replace(stringAllLastNewLines, "") : textBlock; | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| import * as Handlebars from 'handlebars'; | ||
| import { ICombinedBooksAndHighlights } from '../types'; | ||
| import 'src/utils/helpers' | ||
| export const renderHighlightsTemplate = async (highlight: ICombinedBooksAndHighlights, template: string) => { | ||
| const compiledTemplate = Handlebars.compile(template); | ||
| const renderedTemplate = compiledTemplate(highlight); | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -43,7 +43,7 @@ export class IBookHighlightsSettingTab extends PluginSettingTab { | |
|
|
||
| new Setting(containerEl) | ||
| .setName('Import highlights on start') | ||
| .setDesc('Import all highlights from all your books when Obsidian starts') | ||
| .addToggle((toggle) => { | ||
| toggle.setValue(this.plugin.settings.importOnStart) | ||
| .onChange(async (value) => { | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,6 +13,7 @@ Number of annotations:: {{annotations.length}} | |
| - 🔖 Context:: {{#if contextualText}}{{{contextualText}}}{{else}}N/A{{/if}} | ||
| - 🎯 Highlight:: {{{highlight}}} | ||
| - 📝 Note:: {{#if note}}{{{note}}}{{else}}N/A{{/if}} | ||
| - 📙 Highlight Link:: {{#if highlightLocation}}[Apple Books Highlight Link](ibooks://assetid/{{../bookId}}#{{highlightLocation}}){{else}}N/A{{/if}} | ||
| {{/each}} | ||
| `; | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,6 +13,7 @@ export interface IBookAnnotation { | |
| ZFUTUREPROOFING5: string; | ||
| ZANNOTATIONREPRESENTATIVETEXT: string; | ||
| ZANNOTATIONSELECTEDTEXT: string; | ||
| ZANNOTATIONLOCATION: string; | ||
| ZANNOTATIONNOTE: string; | ||
| ZANNOTATIONCREATIONDATE: number; | ||
| ZANNOTATIONMODIFICATIONDATE: number; | ||
|
|
@@ -23,6 +24,7 @@ export interface IHighlight { | |
| chapter: string; | ||
| contextualText: string; | ||
| highlight: string; | ||
| highlightLocation: string; | ||
| note: string; | ||
| } | ||
| export interface ICombinedBooksAndHighlights { | ||
|
|
||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.