MediaWiki:Gadget-templating.js

/* global mw, $ */
mw.loader.using(['mediawiki.api']).done(function () {

  // ===== 0) CONFIG =====
  var SEARCH_QUERY = 'haswbstatement:P1=Q196450'; // exactly what works in Special:Search
  var WbTemplates = {};
  var api = new mw.Api();
  var userLang = mw.config.get('wgUserLanguage') || 'en';
// Serialize all UI writes so nothing overlaps
var WriteQueue = (function () {
  var chain = Promise.resolve();
  function push(taskFn) {
    chain = chain.then(function () {
      return taskFn();
    }).catch(function (e) {
      console.error('Write failed:', e);
      // swallow so the queue continues
    });
    return chain;
  }
  return { push: push };
})();
  // ===== 1) Small helpers (ES5-safe) =====
  function chunk(arr, n) {
    var out = [], i;
    for (i = 0; i < arr.length; i += n) out.push(arr.slice(i, i + n));
    return out;
  }
  function getBestLabel(labels) {
    if (!labels) return undefined;
    if (labels[userLang] && labels[userLang].value) return labels[userLang].value;
    for (var k in labels) {
      if (labels[k] && labels[k].value) return labels[k].value;
    }
    return undefined;
  }
  function isPlaceholderSnak(snak) {
    if (!snak || snak.snaktype !== 'value' || !snak.datavalue) return false;
    var dt = snak.datatype;
    var v = snak.datavalue.value;
    if (dt === 'string' || dt === 'external-id' || dt === 'url') return v === '_';
    if (dt === 'monolingualtext') return v && v.text === '_';
    return false;
  }
  function cleanTemplateLabel(raw) {
    if (!raw) return '';
    return raw.replace(/^RDA\s*/i, '').replace(/\s*Template$/i, '').trim();
  }
  function slugify(s) {
    if (!s) return '';
    // simple slug (ASCII only)
    return s.toLowerCase().replace(/[^a-z0-9]+/g, '-').replace(/^-+|-+$/g, '');
  }

  // ===== 2) API: search → entities → property meta =====
  function searchTemplates(query) {
    return api.get({
      action: 'query',
      list: 'search',
      srsearch: query,
      srbackend: 'CirrusSearch',
      srqiprofile: 'wikibase',
      srnamespace: 120,
      srlimit: 50,
      formatversion: 2
    }).then(function (res) {
      var hits = (res.query && res.query.search) || [];
      var ids = [];
      for (var i = 0; i < hits.length; i++) {
        var m = /Q\d+$/.exec(hits[i].title);
        if (m) ids.push(m[0]);
      }
      return ids;
    });
  }

  function fetchEntities(ids) {
    var out = {};
    var batches = chunk(ids, 50);
    var d = $.Deferred();
    (function next(i) {
      if (i >= batches.length) { d.resolve(out); return; }
      api.get({
        action: 'wbgetentities',
        ids: batches[i].join('|'),
        props: 'labels|claims',
        languages: userLang
      }).then(function (res) {
        $.extend(out, res.entities || {});
        next(i + 1);
      }).fail(d.reject);
    })(0);
    return d.promise();
  }

  function fetchPropertyMeta(entityMap) {
    var pids = {};
    for (var qid in entityMap) {
      var claims = entityMap[qid].claims || {};
      for (var pid in claims) pids[pid] = true;
    }
    var ids = Object.keys(pids);
    var out = {};
    var batches = chunk(ids, 50);
    var d = $.Deferred();
    (function next(i) {
      if (i >= batches.length) { d.resolve(out); return; }
      api.get({
        action: 'wbgetentities',
        ids: batches[i].join('|'),
        props: 'labels|datatype',
        languages: userLang
      }).then(function (res) {
        $.extend(out, res.entities || {});
        next(i + 1);
      }).fail(d.reject);
    })(0);
    return d.promise().then(function () {
      // normalize
      var meta = {};
      for (var pid in out) {
        var ent = out[pid] || {};
        meta[pid] = {
          id: pid,
          label: getBestLabel(ent.labels) || pid,
          datatype: ent.datatype
        };
      }
      return meta;
    });
  }

  // ===== 3) Transform to your WbTemplates shape =====
  function transformToTemplate(entity, propMeta) {
    var rawLabel = getBestLabel(entity.labels) || entity.id;
    var label = cleanTemplateLabel(rawLabel);

    var prefilledClaims = [];
    var userDefinedClaims = [];

    var claims = entity.claims || {};
    for (var pid in claims) {
      var statements = claims[pid];
      if (!statements || !statements.length) continue;

      var prop = propMeta[pid] || { id: pid, label: pid, datatype: 'string' };

      // find first non-placeholder
      var firstNonPlaceholder = null;
      for (var i = 0; i < statements.length; i++) {
        var ms = statements[i] && statements[i].mainsnak;
        if (ms && ms.snaktype === 'value' && !isPlaceholderSnak(ms)) {
          firstNonPlaceholder = ms;
          break;
        }
      }

      if (firstNonPlaceholder && prop.datatype === 'wikibase-item') {
        var v = firstNonPlaceholder.datavalue && firstNonPlaceholder.datavalue.value;
        prefilledClaims.push({
          property: { id: prop.id, label: prop.label, datatype: prop.datatype },
          value: { mainVal: { id: v && v.id, datatype: 'wikibase-item' } }
        });
      } else {
        userDefinedClaims.push({
          property: { id: prop.id, label: prop.label },
          datatype: prop.datatype
        });
      }
    }

	console.log({ key: slugify(label), label: label, prefilledClaims: prefilledClaims, userDefinedClaims: userDefinedClaims });

    return { key: slugify(label), label: label, prefilledClaims: prefilledClaims, userDefinedClaims: userDefinedClaims };
  }

  function buildWbTemplatesFromQuery(query) {
    return searchTemplates(query).then(function (qids) {
      if (!qids.length) return {};
      return fetchEntities(qids).then(function (entities) {
        return fetchPropertyMeta(entities).then(function (propMeta) {
          var map = {};
          for (var eid in entities) {
            var tpl = transformToTemplate(entities[eid], propMeta);
            map[tpl.key] = {
              label: tpl.label,
              prefilledClaims: tpl.prefilledClaims,
              userDefinedClaims: tpl.userDefinedClaims
            };
          }
            //	return { "person": { "label": "Person", "prefilledClaims": [{ "property": {id: "P1", label: "instance of", datatype: "wikibase-item"}, "value": { "mainVal": {id: "Q78", datatype: "wikibase-item"} } },{ "property": {id: "P2", label: "subclass of", datatype: "wikibase-item"}, "value": { "mainVal": {id: "Q79", datatype: "wikibase-item"} } }], "userDefinedClaims": [ { "property": {id: "P162", label: "has authorized access point for person [a/datatype] (RDA:P50411)"}, datatype: "string" }, { "property": {id: "P1087", label: "has surname [a/datatype] (RDA:P50291)"}, datatype: "string" }, { "property": {id: "P579", label: "has given name [a/datatype] (RDA:P50292)"}, datatype: "string" }, { "property": {id: "P1105", label: "has term of rank or honour or office [a/datatype] (RDA:P50110)"}, datatype: "string" }, { "property": {id: "P1893", label: "has place of birth [a/object] (RDA:P50119)"}, datatype: "wikibase-item" }, { "property": {id: "P2251", label: "has profession or occupation [a/object] (RDA:P50104)"}, datatype: "wikibase-item" }, { "property": {id: "P2250", label: "has language of person [a/object] (RDA:P50102)"}, datatype: "wikibase-item" }, { "property": {id: "P1123", label: "has variant access point for person [a/datatype] (RDA:P50412)"}, datatype: "string" }, { "property": {id: "P2007", label: "has related corporate body of person [a/object] (RDA:P50318)"}, datatype: "wikibase-item" }, { "property": {id: "P756", label: "has note on person [a/datatype] (RDA:P50395)"}, datatype: "string" }, ], }, "corporate": { "label": "Corporate Body", "prefilledClaims": [ { "property": {id: "P1", label: "instance of", datatype: "wikibase-item"}, "value": { "mainVal": {id: "Q72", datatype: "wikibase-item"} } } ], "userDefinedClaims": [ { "property": {id: "P10814", label: "has longitude and latitude (P60345)"}, datatype: "globe-coordinate" }, { "property": {id: "P160", label: "has authorized access point for corporate body [a/datatype] (RDA:P50407)"}, datatype: "string" }, { "property": {id: "P1121", label: "has variant access point for corporate body [a/datatype] (RDA:P50408)"}, datatype: "string" }, { "property": {id: "P754", label: "has note on corporate body [a/datatype] (RDA:P50393)"}, datatype: "string" }, ], }, };

          return map;
        });
      });
    });
  }

  // ===== 4) YOUR existing helpers (unchanged) =====
  function statementExists(property, value) {
    items.toArray().some(function (item) {
      return !!$(item).data().propertyId &&
        $(item).data().statementgroupview.options.value.getKey() === property &&
        $(item).data().statementgroupview.options.value.getItemContainer().toArray().some(function (claimItem) {
          return claimItem.getClaim().getMainSnak().getValue().getSerialization() === value;
        });
    });
  }

  function getPropertyEntity(property) {
    return {
      id: String(property.id),
      title: 'Property:' + property.id,
      datatype: property.datatype,
      label: property.label
    };
  }
  
function getStatementCount(pid) {
  var count = 0;
  $('.wikibase-statementgroupview').each(function () {
    var d = $(this).data();
    if (d && d.propertyId === pid) {
      try { count = d.statementgroupview.statementlistview._listview.items().length; } catch (e) {}
    }
  });
  return count;
}

function waitForStatementRendered(pid, prevCount, timeoutMs) {
  var start = Date.now(), timeout = timeoutMs || 8000;
  return new Promise(function (resolve) {
    (function tick() {
      var now = getStatementCount(pid);
      if (now > prevCount) return resolve();
      if (Date.now() - start > timeout) return resolve(); // fail-safe
      setTimeout(tick, 100);
    })();
  });
}

/* NEW: wait until the value widget exists for the given datatype */
function waitForValueWidget(snak, datatype, timeoutMs) {
  var start = Date.now(), timeout = timeoutMs || 10000;
  return new Promise(function (resolve, reject) {
    (function tick() {
      var widget = null, jqe = null;
      try {
        var vv = snak && snak._variation && snak._variation._valueView;
        var ex = vv && vv._expert;
        var $input = ex && ex.$input;
        if ($input && $input.length) {
          var data = $input.data();
          if (datatype === 'wikibase-item') {
            widget = data.entityselector || data['mw.widgets.EntitySelector'] || null;
          } else {
            widget = data.inputautoexpand || null;
          }
          jqe = data.jqueryEventSpecialEachchange || null;
        }
      } catch (e) {}
      if (widget) return resolve({ widget: widget, jqe: jqe });
      if (Date.now() - start > timeout) return reject(new Error('value widget not ready'));
      setTimeout(tick, 50);
    })();
  });
}
function prefillStatement(claim, onlyProperty) {
  return new Promise(function (resolve, reject) {
    var pid = claim.property.id;
    var prevCount = getStatementCount(pid);

    if (onlyProperty) {
      pendingStatement(claim.property).then(function () {
        return waitForStatementRendered(pid, prevCount).then(resolve);
      }, reject);
      return;
    }

    var statementListView = $(".wikibase-statementgrouplistview").first().data().wikibaseStatementgrouplistview;
    statementListView.enterNewItem();

    var items = statementListView.listview.items();
    var item = items.last().data();
    var sv = item.statementgroupview.statementlistview._listview.items().first().data().statementview;
    var snak = sv.$mainSnak.data().snakview;

    var es = getPropertyEntity(claim.property);
    var selector = snak._getPropertySelector();

    selector.element.val(es.label);
    selector.element.attr("title", es.label);
    selector._trigger('change');
    selector._select(es);
	if(snak._variation._valueView){
    snak._variation._valueView.element.one(
      snak._variation._valueView.widgetEventPrefix + 'afterstartediting',
      function () {
        var valSelector = snak._variation._valueView._expert.$input.data().entityselector;
        var valval = getPropertyEntity(claim.value.mainVal);

        valSelector.element.val(valval.label);
        valSelector._trigger("change");
        valSelector._select(valval);

        if (claim.qualifiers) {
          var qlistview = sv._qualifiers;
          qlistview.enterNewItem();

          var qslv = $(sv._qualifiers.items().first()).data().snaklistview;
          var qsnak = qslv._listview.items().first().data().snakview;

          var qsel = qsnak._getPropertySelector();
          qsel.element.val(es.label);
          qsel._trigger('change');
          qsel._select(es);

          qsnak._variation._valueView.element.one(
            qsnak._variation._valueView.widgetEventPrefix + 'afterstartediting',
            function () {
              var qvalSelector = qsnak._variation._valueView._expert.$input.data().entityselector;
              var qvalval = getPropertyEntity(claim.value.mainVal);
              qvalSelector.element.val(qvalval.label);
              qvalSelector._trigger("change");
              qvalSelector._select(qvalval);
            }
          );
        }
      }
    );

    snak._variation._valueView.element.one(
      snak._variation._valueView.widgetEventPrefix + 'change',
      function () {
        var toolbar = item.statementgroupview.statementlistview._listview.items().last().data().edittoolbar;
        var resolved = false;
        function doneOnce() { if (!resolved) { resolved = true; } }

        // Trigger save
        try { toolbar._controller.stopEditing(false); } catch (e) {}

        // Wait for visual render (count + 1) before resolving
        waitForStatementRendered(pid, prevCount).then(function () {
          doneOnce();
          resolve();
        });
      }
    );
	}
  });
}
 function pendingStatement(claim) {
  var prop = claim.property;
  var pid = prop.id;
  var prevCount = getStatementCount(pid);

  return new Promise(function (resolve, reject) {
    var statementListView = $(".wikibase-statementgrouplistview").first().data().wikibaseStatementgrouplistview;
    statementListView.enterNewItem();

    var items = statementListView.listview.items();
    var item = items.last().data();
    var sv = item.statementgroupview.statementlistview._listview.items();
    var snak = $(sv).data().statementview.$mainSnak.data().snakview;

    var selector = snak._getPropertySelector();

    // 1) when property gets selected, the value widget will be (re)drawn
    selector.element.one('entityselectorselected', function () {
      $(snak._variation).one('afterdraw', function () {
        // 2) value view will enter editing -> now wait until the widget exists
        snak._variation._valueView.element.one(
          snak._variation._valueView.widgetEventPrefix + 'afterstartediting',
          function () {
            waitForValueWidget(snak, claim.datatype).then(function (vw) {

              // 3) poke the widget to create a blank statement the user can later fill
              if (claim.datatype === "wikibase-item") {
                var valSelector = vw.widget;
                try {
                  // select a temp value then clear it to trigger 'change'
                  if (valSelector.element) {
                    valSelector.element.val("temp");
                  }
                  if (typeof valSelector._select === 'function') {
                    valSelector._select({ id: "Q80", datatype: "wikibase-item" });
                  }
                  if (valSelector.element) {
                    valSelector.element.val("");
                    valSelector.element.trigger('change');
                  }
                  if (vw.jqe && vw.jqe.handlers) {
                    // fire eachchange handlers if present (older widget versions)
                    for (var i = 0; i < vw.jqe.handlers.length; i++) {
                      try { vw.jqe.handlers[i].call(); } catch (e) {}
                    }
                  }
                } catch (e) {
                  console.warn('entityselector poke failed', e);
                }
              } else {
                var iae = vw.widget; // inputautoexpand
                try {
                  var $inp = iae.$input || (snak._variation._valueView._expert.$input);
                  if ($inp && $inp.length) {
                    if (claim.datatype === "globe-coordinate") {
                      $inp.val("0,0");
                    } else {
                      $inp.val("__");
                    }
                    $inp.trigger('input').trigger('change');
                    // clear back to blank
                    $inp.val("").trigger('input').trigger('change');
                  }
                  if (vw.jqe && vw.jqe.handlers) {
                    for (var j = 0; j < vw.jqe.handlers.length; j++) {
                      try { vw.jqe.handlers[j].call(); } catch (e2) {}
                    }
                  }
                } catch (e3) {
                  console.warn('inputautoexpand poke failed', e3);
                }
              }
            }).catch(function (err) {
              console.error('waitForValueWidget failed', err);
            });
          }
        );
      });
    });

    // 4) select the property (triggers entityselectorselected + redraw)
    selector.element.val(prop.label);
    selector._trigger('change');
    selector._select(prop);

    // 5) when the value view emits 'change', save; then wait for visual render

    snak._variation._valueView.element.one(
      snak._variation._valueView.widgetEventPrefix + 'change',
      function () {
        var toolbar = item.statementgroupview.statementlistview._listview.items().last().data().edittoolbar;
        try { toolbar._controller.stopEditing(false); } catch (e) {}
        waitForStatementRendered(pid, prevCount).then(resolve);
      }
    );
    
  });
}
function getExistingPropertyIds() {
  var map = {};
  $('.wikibase-statementgroupview').each(function () {
    var d = $(this).data();
    if (d && d.propertyId) map[d.propertyId] = true;
  });
  return map;
}

function addDetails(templateName, opts) {
  opts = opts || {};
  var skipExisting = (typeof opts.skipExisting === 'boolean') ? opts.skipExisting : true;

  var tpl = WbTemplates[templateName] || { userDefinedClaims: [] };
  var claims = (tpl.userDefinedClaims || []).slice();
  var existing = getExistingPropertyIds();

  var seq = Promise.resolve();
  claims.forEach(function (claim) {
    if (skipExisting && existing[claim.property.id]) { return; }
    seq = seq.then(function () {
      return WriteQueue.push(function () {
        return pendingStatement(claim).then(function () {
          existing[claim.property.id] = true;
        });
      });
    });
  });
  return seq;
}
function applyTemplate(templateName) {
  var claims = (WbTemplates[templateName].prefilledClaims || []).slice();
  var seq = Promise.resolve();
  claims.forEach(function (claim) {
    seq = seq.then(function () {
      return WriteQueue.push(function () {
        return prefillStatement(claim, false); // returns a Promise
      });
    });
  });
  return seq;
}

  // ===== 5) UI (render AFTER templates are loaded) =====
  function initTemplatingUI() {
    var html = ''
      + '<div class="wikibase-templating-section">'
      + '  <div class="wikibase-templating-section-title"><span class="magic-wand-icon"></span> RDA Entity template</div>'
      + '  <div class="wikibase-templating-help"><span class="settings-text">Select an RDA entity class to apply predefined template entries and additional entity details.</span></div>'
      + '  <div class="wikibase-templating-form oo-ui-labelElement oo-ui-fieldLayout">'
      + '    <div class=""><label for="wbtemplate">Entity class</label></div>'
      + '    <div><select id="wbtemplate" class="cdx-select"></select></div>'
      + '  </div>'
      + '  <div class="mw-htmlform-submit-buttons">'
      + '    <button id="applyTemplateBtn" class="cdx-button">Apply template</button>'
      + '    <button id="addDetailsBtn" class="cdx-button">Add details</button>'
      + '  </div>'
      + '</div>';

    $('.wikibase-entitytermsview').append(html);

    var key;
    for (key in WbTemplates) {
      $('#wbtemplate').append($('<option>', {
        value: key,
        text: WbTemplates[key].label
      }));
    }

function applyTemplate(templateName) {
  var claims = (WbTemplates[templateName].prefilledClaims || []).slice();
  var chain = Promise.resolve();
  claims.forEach(function (claim) {
    chain = chain.then(function () { return prefillStatement(claim, false); });
  });
  return chain;
}

$('#applyTemplateBtn').off('click').on('click', function () {
  var $b=$(this).prop('disabled', true);
  applyTemplate($('#wbtemplate').val()).then(function(){ $b.prop('disabled', false); });
});
$('#addDetailsBtn').off('click').on('click', function () {
  var $b=$(this).prop('disabled', true);
  addDetails($('#wbtemplate').val(), { skipExisting: true }).then(function(){ $b.prop('disabled', false); });
});
  }

  // ===== 6) Build templates, then render UI =====
  buildWbTemplatesFromQuery(SEARCH_QUERY)
    .then(function (map) {
      WbTemplates = map;
      window.WbTemplates = WbTemplates; // if you need it elsewhere
      if (!WbTemplates || !Object.keys(WbTemplates).length) {
        console.warn('No templates found for query:', SEARCH_QUERY);
        return;
      }
      initTemplatingUI();
    })
    .fail(function (err) {
      // If this fails for anonymous users, it might be auth/profile config
      // related; try while logged in.
      console.error('Template build failed:', err);
    });

});