MediaWiki:Gadget-GrAnnotations.js: Difference between revisions

  * gr_annotations.js  —  grantha.io inline Notes + Bookmarks + Footnotes + Feedback

  * (v7 — server-backed storage + unified highlight→card behaviour)

*      is still used, but only as an offline cache + a write queue.

* the Footnotes tab reads them straight off the DOM, same as before.

 

 

 

   // FIXED (carried over from v6): mw.Api must never be constructed

   // synchronously at file scope — at this point in Common.js's own load

   // lifecycle the mediawiki.api module isn't guaranteed to be ready, and

   // calling the constructor early throws "mw.Api is not a constructor",

   // which would halt the rest of this script. Everything that needs the

   // API goes through this one lazy, memoised getter instead.

 

 

 

  * A failed write is never silently dropped. It goes here, and the next

  * page load flushes it before reading. The queue is global rather than

  * per-page because a write can fail on one page and only get retried

  function pendingSet( q ) { lsSet( PENDING_LS_KEY, q ); }

 

 

   // Flushes the queue one op at a time, in order. Order matters: a

  // save→delete pair for the same id replayed out of order would

  // resurrect a deleted annotation. Anything that fails again is put

   // back for the next attempt rather than discarded.

    return queue.reduce( function ( chain, op ) {

 

  // for this page, so a user who has been annotating anonymously (or

   // before this change shipped) doesn't lose anything on first sign-in.

  // Only marks the page migrated once the queue has actually drained —

      // Bookmarks call their body "name" in the UI; the server stores one

  function markMigrated() {

    try { localStorage.setItem( MIGRATED_LS_KEY, '1' ); } catch ( e ) {}

 

 

   // Loads this page's annotations into _notes / _bookmarks. Always

  // resolves — a server that's down degrades to the local cache rather

   // than leaving the panel empty and the page un-highlighted.

   function loadPageAnnotations() {

        // Mirror into localStorage so this page still renders its

        // annotations on a later offline visit.

        console.error( 'grantha annotations: load failed, using local cache:', code, result );

        _notes    = lsGet( NT_LS_KEY );

 

  // Both writers below are optimistic: _notes/_bookmarks and the local

   // mirror are already updated by the caller, so the UI never waits on

   // the network. The server call is fire-and-forget with a retry queue.

   function storeSave( type, record ) {

 

      $n = $( '<div id="gra-sync-notice" role="status" aria-live="polite"></div>' );

      $( 'body' ).append( $n );

 

 

     api().then( function ( a ) {

       return a.get( { action: 'query', meta: 'userinfo', uiprop: 'email', formatversion: 2 } );

     } ).then( function ( data ) {

     var note = {id:id, ts:ts, quote:quote, text:text};

     _notes.push(note);

     // CHANGED: was persistNotes() + persistNoteHighlight(). The separate

    // {id, quote}, which the note record itself already carries, so

    storeSave('note', note);

   function deleteNote(id) {

     _notes = _notes.filter(function(n){ return n.id !== id; });

    var span = document.querySelector('[data-gra-id="'+id+'"].gra-note-highlight');

     if (span && span.parentNode) {

      var p = span.parentNode;

      while (span.firstChild) p.insertBefore(span.firstChild, span);

      p.removeChild(span);

    }

    storeDelete('note', id);

     var bm = {id:id, name:name, quote:quote, ts:nowIso()};

    _bookmarks.push(bm);

     // The server column is "text" for both types — see toBookmark().

    storeSave('bookmark', {id:bm.id, quote:bm.quote, text:bm.name, ts:bm.ts});

     storeDelete('bookmark', id);

     renderBookmarkCards();

   // Footnotes aren't personal annotations — they're real saved page

   // content (QuickEdit writes .gra-qe-footnotes/.gra-qe-footnote-item

   // into the article HTML). So this reads straight off the live DOM on

   // every open: no fetch, no storage, and deliberately not part of the

   // per-user sync above.

     // Footnote highlights carry data-gra-id (see quickedit.js's redesign —

     // plain highlight span, no href/marker element), so this reuses the

     // same scrollToHighlight helper as notes and bookmarks.

       focusPanelCard($paneNotes, 'notes', $(this).attr('data-gra-id'));

       focusPanelCard($paneBookmarks, 'bookmarks', $(this).attr('data-gra-id'));

       focusPanelCard($paneFootnotes, 'footnotes', $(this).attr('data-gra-id'));

     // Cross-document links from QuickEdit's Link picker. No real href is

     // ever saved (MediaWiki's sanitizer escapes <a href> into visible

    // literal text on this wiki, even for a full absolute URL) — the

    // target lives in data-gr-href, and this handler navigates.

       if (newWin) newWin.opener = null; // more reliable cross-browser than window.open's features string

   // CHANGED: re-anchors note highlights from _notes directly, rather than

  // from the old separate NT_LS_KEY+'_hl' list. Each note already carries

  // its own quote, so that parallel list was duplicated state — and once

  // notes come from the server, a stale local '_hl' copy would have been

   // an active source of wrong highlights.

     _notes.forEach(function(n){

       if (!n.quote || !n.id) return;

       if (document.querySelector('[data-gra-id="'+n.id+'"].gra-note-highlight')) return;

       var needle = n.quote.replace(/…$/,'').trim().slice(0,80);

       sp.setAttribute('data-gra-id', n.id);

      sp.setAttribute('data-gra-quote', n.quote);

 

     // CHANGED: loading is now asynchronous (it may hit the network), so

     // falls back to the local cache internally rather than rejecting, so

      renderNoteCards();

      setTimeout(function(){

        try { restoreNoteHighlights(); } catch(e){}

        try { restoreBookmarkHighlights(); } catch(e){}

     }

    loadPageAnnotations().then(afterLoad, afterLoad);