bear.py

import json

from config import get_bear_api_token
from xcall import xcall


def _wiki_link_escaped(value: str) -> str:
    return value.replace('/', '\\/')


def _backlink_search_terms(note):
    search_title = note.title
    search_title = _wiki_link_escaped(search_title)
    if '"' in search_title or '“' in search_title or '”' in search_title:
        search_title = search_title.replace('“', '"')
        search_title = search_title.replace('”', '"')
        parts = search_title.split('"')
        search_title = ""
        for p in parts:
            p = p.strip()
            if len(p) == 0:
                continue
            search_title = search_title + '"' + p + '"' + ' '
        search_title = search_title.strip()
    else:
        search_title = '"[[' + search_title + '"'
    search_id = '"'+note.id+'"'
    return [search_title, search_id]


class Note(object):
    """
    Note is a complete note as returned by bear://x-callback-url/open-note
    """

    def __init__(self, xcall_dict):
        """
        Args:
            xcall_dict: note dict as returned from xcall, including handling any weird escaping
        """
        self.title = xcall_dict['title']
        self.id = xcall_dict['identifier']
        self.content = xcall_dict['note']
        if xcall_dict['is_trashed'] == 'yes':
            self.trashed = True
        else:
            self.trashed = False

    def __hash__(self):
        return hash(self.id) ^ hash(self.content)

    def __repr__(self):
        return f'<bear.Note {self.id} "{self.title[:30]}">'

    @property
    def title_escaped_for_wiki_link(self):
        """
        Returns: the title of this note, properly escaped to put inside [[...]]
                 for a link.

        Notes:
            - Bear does not escape backticks in these links (`), but links including
            are not actually clickable, probably because the editor doesn't generally
            handle nested Markdown.

        """
        return _wiki_link_escaped(self.title)

    @property
    def backlink_search_terms(self):
        return _backlink_search_terms(self)


class NoteStub(object):
    """
    NoteStub is a "stub" note as returned by bear://x-callback-url/search
    """

    def __init__(self, xcall_dict):
        """
        Args:
            xcall_dict: note dict as returned from xcall, including handling any weird escaping
        """
        self.title = xcall_dict['title']
        self.id = xcall_dict['identifier']

    def __hash__(self):
        return hash(self.id) ^ hash(self.title)

    def __repr__(self):
        return f'<bear.NoteStub {self.id} "{self.title[:30]}">'

    def to_note(self) -> Note:
        return get_note(self.id)

    @property
    def title_escaped_for_wiki_link(self):
        """
        Returns: the title of this note, properly escaped to put inside [[...]]
                 for a link.

        Notes:
            - Bear does not escape backticks in these links (`), but links including
            are not actually clickable, probably because the editor doesn't generally
            handle nested Markdown.

        """
        return _wiki_link_escaped(self.title)

    @property
    def backlink_search_terms(self):
        return _backlink_search_terms(self)


class SearchResults(object):
    """
    SearchResults is an iterable collection of note stubs returned from a Bear search.
    It handles the weird double-JSON-encoding we're getting back from xcall.
    """

    def __init__(self, xcall_dict):
        self.note_stubs = [NoteStub(s) for s in json.loads(xcall_dict['notes'])]

    def __iter__(self):
        return iter(self.note_stubs)

    def __len__(self):
        return len(self.note_stubs)

    def __getitem__(self, i):
        return self.note_stubs[i]


def search_term(term: str) -> SearchResults:
    """
    Search Bear for the given term.

    See Also:
        https://bear.app/faq/X-callback-url%20Scheme%20documentation/#search

    Args:
        term: Term to search for.

    Returns:
        SearchResults
    """
    return SearchResults(xcall_dict=xcall('bear', 'search', {
        'term': term,
        'token': get_bear_api_token(),
        'show_window': 'no',
    }))


def get_note(note_id: str) -> Note:
    return Note(xcall_dict=xcall('bear', 'open-note', {
        'id': note_id,
        'show_window': 'no',
        'open_note': 'no',
    }))


def replace_note_contents(note_id: str, new_contents: str):
    _ = xcall('bear', 'add-text', {
        'id': note_id,
        'mode': 'replace_all',
        'text': new_contents,
        'open_note': 'no',
        'show_window': 'no',
    })