☰

Kanka.io Keybinds

Set your own keyboard shortcuts for entity view page on Kanka.

当前为 2024-03-05 提交的版本，查看 最新版本。

  1. // ==UserScript==
  2. // @name         Kanka.io Keybinds
  3. // @namespace    http://tampermonkey.net/
  4. // @version      0.8.3-4
  5. // @description  Set your own keyboard shortcuts for entity view page on Kanka.
  6. // @author       Infinite
  7. // @license      MIT
  8. // @match        https://app.kanka.io/w/*/entities/*
  9. // @icon         https://www.google.com/s2/favicons?domain=kanka.io
  10. // @run-at       document-idle
  11. // @grant        none
  12. // @require      https://craig.global.ssl.fastly.net/js/mousetrap/mousetrap.min.js?a4098
  13. // @require      https://cdnjs.cloudflare.com/ajax/libs/select2/4.0.13/js/select2.min.js
  14. // ==/UserScript==
  15.  
  16. /******/ (() => { // webpackBootstrap
  17. /******/ 	"use strict";
  18. /******/ 	var __webpack_modules__ = ({
  19.  
  20. /***/ 519:
  21. /***/ (function(__unused_webpack_module, exports, __webpack_require__) {
  22.  
  23.  
  24. var __importDefault = (this && this.__importDefault) || function (mod) {
  25.     return (mod && mod.__esModule) ? mod : { "default": mod };
  26. };
  27. var _a, _b, _c, _d, _e, _f;
  28. Object.defineProperty(exports, "__esModule", ({ value: true }));
  29. /*  ====================================
  30.         You can change these keybinds
  31.     ====================================
  32. */
  33. const keybinds = {
  34.     LABEL: 'l',
  35.     MOVE: 'm',
  36.     HELP: '?',
  37. };
  38. /*
  39.  
  40. ## Combination of keys - generic mod helper sets cross platform shortcuts
  41.     'mod+s' => command+s / ctrl+s
  42.  
  43. ## Sequence of keys - keys separated by a space will be considered a sequence
  44.     'g i'
  45.  
  46. ## Shift key - handled magically
  47.     '?' instead of 'shift+/'
  48.  
  49. ## Text fields - keyboard events will not fire in textarea, input, or select
  50.     enable with [class='mousetrap']
  51.  
  52. */
  53. /*  =======================================
  54.         You probably shouldn't edit below
  55.     ======================================= */
  56. const mousetrap_1 = __importDefault(__webpack_require__(802));
  57. // import tippy from 'tippy';
  58. const emit_debug = console.log;
  59. function parseBodyClasses(body) {
  60.     const classes = Array.from(body.classList);
  61.     const entity = { id: '', entityType: 'default', type: '' };
  62.     const tags = [];
  63.     const regex = /^kanka-(\w+)-(\w+)$/;
  64.     let tempTag = null;
  65.     classes.forEach(className => {
  66.         const match = className.match(regex);
  67.         if (match) {
  68.             const [, key, value] = match;
  69.             const isValueNumeric = !isNaN(Number(value));
  70.             switch (key) {
  71.                 case 'entity':
  72.                     entity[isValueNumeric ? 'id' : 'entityType'] = value;
  73.                     break;
  74.                 case 'type':
  75.                     entity.type = value;
  76.                     break;
  77.                 case 'tag':
  78.                     if (isValueNumeric) {
  79.                         tempTag = value;
  80.                     }
  81.                     else {
  82.                         tags.push({
  83.                             id: tempTag,
  84.                             entityType: value,
  85.                         });
  86.                         tempTag = null;
  87.                     }
  88.                     break;
  89.                 default:
  90.                     emit_debug("what's this?", match);
  91.                     break;
  92.             }
  93.         }
  94.     });
  95.     return { tags, entity };
  96. }
  97. const route = window.location.pathname;
  98. // this is necessary to get the typedID and the plural 
  99. const editButtonLink = (_a = $('div#entity-submenu a[href$="edit"]').attr('href')) !== null && _a !== void 0 ? _a : $('div.header-buttons a[href$="edit"]').attr('href');
  100. const kanka = {
  101.     csrfToken: (_b = document.head.querySelector('meta[name="csrf-token"]')) === null || _b === void 0 ? void 0 : _b.getAttribute('content'),
  102.     route,
  103.     campaignID: ((_c = route.match(/w\/(\d+)\//)) !== null && _c !== void 0 ? _c : [null, '0'])[1],
  104.     // this is the plural, not values from EntityType
  105.     entityType: ((_d = editButtonLink === null || editButtonLink === void 0 ? void 0 : editButtonLink.match(/\/(\w+)\/\d+\/edit$/)) !== null && _d !== void 0 ? _d : [null, '0'])[1],
  106.     // this is the 'larger' ID: entities/*5328807* === characters/1357612
  107.     entityID: ((_e = route.match(/w\/\d+\/entities\/(\d+)/)) !== null && _e !== void 0 ? _e : [null, '0'])[1],
  108.     // this is the 'smaller' ID: entities/5328807 === characters/*1357612*
  109.     typedID: ((_f = editButtonLink === null || editButtonLink === void 0 ? void 0 : editButtonLink.match(/\/(\d+)\/edit$/)) !== null && _f !== void 0 ? _f : [null, '0'])[1],
  110.     meta: parseBodyClasses(document.body),
  111.     entityTypeHasLocation: ({
  112.         default: {},
  113.         character: { headerLink: true },
  114.         location: { headerLink: true },
  115.         map: { headerLink: true },
  116.         organisation: { sidebarLink: true },
  117.         family: { headerLink: true },
  118.         creature: { sidebarLink: true, multiple: true },
  119.         race: { sidebarLink: true, multiple: true },
  120.         event: { sidebarLink: true },
  121.         journal: { sidebarLink: true },
  122.         item: { sidebarLink: true },
  123.         tag: {},
  124.         note: {},
  125.         quest: {},
  126.     }),
  127.     bulkEditUrl: '',
  128.     entityEditUrl: '',
  129. };
  130. kanka.bulkEditUrl = `/w/${kanka.campaignID}/bulk/process`;
  131. kanka.entityEditUrl = `/w/${kanka.campaignID}/${kanka.entityType}/${kanka.typedID}`;
  132. const handlers = {
  133.     [keybinds.LABEL]: function (evt, combo) {
  134.         initSelector(templates.TAG_SELECT, processTagSelection);
  135.     },
  136.     [keybinds.MOVE]: function (evt, combo) {
  137.         initSelector(templates.LOCATION_SELECT, processLocationSelection);
  138.     },
  139.     [keybinds.HELP]: function (evt, combo) {
  140.         // TODO show a modal describing the keybinds
  141.     },
  142. };
  143. const templates = {
  144.     SELECT_ELEMENT: (dataUrl, placeholder) => `
  145. <select class="form-tags select2"
  146.     style="width: 100%"
  147.     data-url="${dataUrl}"
  148.     data-allow-new="false"
  149.     data-allow-clear="true"
  150.     data-placeholder="${placeholder}"
  151.     data-dropdown-parent="#app"
  152. </select>`.trim(),
  153.     SELECT_ITEM: (text, image) => {
  154.         if (!!image) {
  155.             return $(`
  156. <span class="flex gap-2 items-center text-left">
  157.     <img src="${image}" class="rounded-full flex-none w-6 h-6" />
  158.     <span class="grow">${text}</span>
  159. </span>`.trim());
  160.         }
  161.         return $(`<span>${text}</span>`);
  162.     },
  163.     TAG_SELECT: () => templates.SELECT_ELEMENT(`https://app.kanka.io/w/${kanka.campaignID}/search/tags`, 'Apply Tag'),
  164.     TAG_URL: (tagID) => `https://app.kanka.io/w/${kanka.campaignID}/tags/${tagID}`,
  165.     TAG_LINK: (tagID, text) => `
  166. <a href="${templates.TAG_URL(tagID)}" title="Refresh to get full tooltip functionality">
  167.     <span class="badge color-tag rounded-sm px-2 py-1">${text}</span>
  168. </a>`.trim(),
  169.     LOCATION_SELECT: () => templates.SELECT_ELEMENT(`https://app.kanka.io/w/${kanka.campaignID}/search/locations`, 'Move to...'),
  170.     LOCATION_URL: (locationID) => `https://app.kanka.io/w/${kanka.campaignID}/entities/${locationID}`,
  171.     LOCATION_LINK: (locationID, text) => `<a class="name" href="${templates.LOCATION_URL(locationID)}" title="Refresh to get full tooltip functionality">${text}</a>`,
  172.     // TODO - get popper/tippy working to enable preview tooltips 
  173.     // data-toggle="tooltip-ajax" data-id="${locationID}" data-url="${templates.LOCATION_URL(locationID)}/tooltip">
  174. };
  175. /// making my own container for the select to avoid any interference
  176. function createFloatingElement(template) {
  177.     let floatingDiv = document.getElementById('#infinite-select2');
  178.     if (!floatingDiv) {
  179.         floatingDiv = document.createElement('div');
  180.         floatingDiv.id = 'infinite-select2';
  181.         // Add styles to make it float and position it as needed
  182.         floatingDiv.style.position = 'absolute';
  183.         floatingDiv.style.top = '5%';
  184.         floatingDiv.style.left = '41%';
  185.         floatingDiv.style.minWidth = '200px';
  186.         floatingDiv.style.width = '18%';
  187.         floatingDiv.style.maxWidth = '400px';
  188.     }
  189.     floatingDiv.innerHTML = '';
  190.     $(template()).appendTo(floatingDiv);
  191.     document.body.appendChild(floatingDiv);
  192.     return floatingDiv;
  193. }
  194. function createPostParams() {
  195.     const params = new URLSearchParams();
  196.     params.append('_token', kanka.csrfToken);
  197.     params.append('datagrid-action', 'batch');
  198.     // this needs the plural
  199.     params.append('entity', kanka.entityType);
  200.     params.append('mode', 'table');
  201.     // typedID is different from entityID
  202.     params.append('models', kanka.typedID);
  203.     params.append('undefined', '');
  204.     return params;
  205. }
  206. async function fetch_success(response) {
  207.     var _a;
  208.     emit_debug('Success:', response);
  209.     const document = await ((_a = response.body) === null || _a === void 0 ? void 0 : _a.getReader().read().then(content => {
  210.         const responseHtml = new TextDecoder().decode(content.value);
  211.         return $.parseHTML(responseHtml);
  212.     }));
  213.     return { ok: response.ok, document: document !== null && document !== void 0 ? document : [] };
  214. }
  215. function post(url, body) {
  216.     return fetch(url, {
  217.         method: 'POST',
  218.         redirect: 'follow',
  219.         headers: {
  220.             'Content-Type': 'application/x-www-form-urlencoded',
  221.         },
  222.         body,
  223.     })
  224.         .then(fetch_success)
  225.         .catch((error) => {
  226.         console.error('Error:', error);
  227.         return { ok: error.ok, document: [] };
  228.     });
  229. }
  230. function edit(body) {
  231.     return fetch(kanka.entityEditUrl, {
  232.         method: 'POST',
  233.         redirect: 'follow',
  234.         headers: {
  235.             'Content-Type': 'application/x-www-form-urlencoded',
  236.         },
  237.         body,
  238.     })
  239.         .then(fetch_success)
  240.         .catch((error) => {
  241.         console.error('Error:', error);
  242.         return { ok: error.ok, document: [] };
  243.     });
  244. }
  245. function processLocationSelection(event) {
  246.     const { id: locationID, text } = event.params.data;
  247.     const params = createPostParams();
  248.     const thisEntityTypeHasLocation = kanka.entityTypeHasLocation[kanka.meta.entity.entityType];
  249.     if (thisEntityTypeHasLocation.multiple) {
  250.         params.append('_method', 'PATCH');
  251.         params.append('save-locations', '1');
  252.         params.append('locations[]', locationID);
  253.         edit(params).then(response => {
  254.             const doc = $(response.document);
  255.             emit_debug({
  256.                 header: doc.find('.entity-header'),
  257.                 sidebar: doc.find('#sidebar-profile-elements'),
  258.             });
  259.         });
  260.         return;
  261.         // if (thisEntityLocation.sidebarLink) {
  262.         //     $('.profile-location')
  263.         //         .children('a.name')
  264.         //         .toArray()
  265.         //         .map(element => element.attributes.getNamedItem('data-id')?.value)
  266.         //         .forEach(oldLocationID => params.append('locations[]', oldLocationID!));
  267.         // }
  268.     }
  269.     params.append('location_id', locationID);
  270.     post(kanka.bulkEditUrl, params)
  271.         .then(response => {
  272.         if (!response.ok)
  273.             return false;
  274.         if (thisEntityTypeHasLocation.headerLink) {
  275.             $('.entity-header').replaceWith($(response.document).find('.entity-header'));
  276.         }
  277.         if (thisEntityTypeHasLocation.sidebarLink) {
  278.             $('#sidebar-profile-elements').replaceWith($(response.document).find('#sidebar-profile-elements'));
  279.             // const sidebar = $('#sidebar-profile-elements > div').first();
  280.             // let sidebar_Location = sidebar.find('.profile-location')
  281.             // if (!sidebar_Location) {
  282.             //     sidebar_Location = $('<div class="element profile-location">')
  283.             //     sidebar_Location.append($('<div class="title text-uppercase text-xs">Location</div>'));
  284.             //     sidebar.prepend(sidebar_Location);
  285.             // }
  286.             // const link = templates.LOCATION_LINK(locationID, text);
  287.             // if (thisEntityLocation.multiple) {
  288.             //     sidebar_Location.append(link);
  289.             // } else {
  290.             //     sidebar_Location.find('a').replaceWith(link);
  291.             // }
  292.         }
  293.     });
  294. }
  295. function processTagSelection(event) {
  296.     const { id: tagID, text } = event.params.data;
  297.     const params = createPostParams();
  298.     params.append('save-tags', '1');
  299.     params.append('tags[]', tagID);
  300.     const header = $('.entity-header .entity-header-text');
  301.     if (header.has('.entity-tags').length == 0) {
  302.         $('<div class="entity-tags entity-header-line text-xs flex flex-wrap gap-2"></div>')
  303.             .insertBefore(header.find('.header-buttons'));
  304.     }
  305.     const hasTag = !!kanka.meta.tags.find(tag => tag.id == tagID);
  306.     params.append('bulk-tagging', hasTag ? 'remove' : 'add');
  307.     return post(`/w/${kanka.campaignID}/bulk/process`, params)
  308.         .then((ok) => {
  309.         const tagBar = header.find('.entity-tags');
  310.         ok && hasTag
  311.             ? tagBar.children().remove(`[href="${templates.TAG_URL(tagID)}"]`)
  312.             : tagBar.append($(templates.TAG_LINK(tagID, text)));
  313.     });
  314.     /*
  315.         // was doing it using the simple 'add entity under tag' API
  316.         // but why not consolidate?
  317.         params.append('entities[]', kanka.meta.entity.id);
  318.         params.append('tag_id', tagID);
  319.     
  320.         post(`/w/${kanka.campaignID}/tags/${tagID}/entity-add/`, params)
  321.             .then((ok) => ok && tagBar.append($(templates.TAG_LINK(tagID, text))));
  322.     */
  323. }
  324. function initSelector(template, processSelection) {
  325.     const floatingDiv = createFloatingElement(template);
  326.     $(floatingDiv).find('select.select2')
  327.         .each(function () {
  328.         const me = $(this);
  329.         me.select2({
  330.             tags: false,
  331.             placeholder: me.data('placeholder'),
  332.             allowClear: me.data('allowClear') || true,
  333.             language: me.data('language'),
  334.             minimumInputLength: 0,
  335.             dropdownParent: $(me.data('dropdownParent')) || '',
  336.             width: '100%',
  337.             sorter: (data) => {
  338.                 const term = $('input.select2-search__field').val().toLowerCase();
  339.                 return data.sort(byMatchiness(term));
  340.             },
  341.             ajax: {
  342.                 delay: 500, // quiet ms
  343.                 url: me.data('url'),
  344.                 dataType: 'json',
  345.                 data: (params) => { var _a; return ({ q: (_a = params.term) === null || _a === void 0 ? void 0 : _a.trim() }); },
  346.                 processResults: (data) => ({ results: data }),
  347.                 error: function (jqXHR, textStatus, errorThrown) {
  348.                     if (textStatus === 'abort') {
  349.                         // it does this for the empty field, I think?
  350.                         return;
  351.                     }
  352.                     if (jqXHR.status === 503) {
  353.                         window.showToast(jqXHR.responseJSON.message, 'error');
  354.                     }
  355.                     emit_debug('error', jqXHR, textStatus, errorThrown);
  356.                     return { results: [] };
  357.                 },
  358.                 cache: true
  359.             },
  360.             templateResult: (item) => templates.SELECT_ITEM(item.text, item.image),
  361.         })
  362.             .on('select2:select', processSelection)
  363.             .on('select2:close', () => {
  364.             setTimeout(() => { $(floatingDiv).remove(); }, 100);
  365.         });
  366.         setTimeout(() => { me.select2('open'); }, 0);
  367.     });
  368. }
  369. function byMatchiness(term) {
  370.     return (a, b) => {
  371.         const textA = a.text.toLowerCase();
  372.         const textB = b.text.toLowerCase();
  373.         // Assign a score based on how well the option matches the search term
  374.         const scoreA = textA === term ? 3 : textA.startsWith(term) ? 2 : textA.includes(term) ? 1 : 0;
  375.         const scoreB = textB === term ? 3 : textB.startsWith(term) ? 2 : textB.includes(term) ? 1 : 0;
  376.         // Sort by score. If the scores are equal, sort alphabetically
  377.         return scoreB - scoreA || textA.localeCompare(textB);
  378.     };
  379. }
  380. (function () {
  381.     if (!document.body.className.includes('kanka-entity-')) {
  382.         return;
  383.     }
  384.     for (const key in handlers) {
  385.         mousetrap_1.default.bind(key, handlers[key]);
  386.     }
  387.     emit_debug(kanka);
  388. })();
  389.  
  390.  
  391. /***/ }),
  392.  
  393. /***/ 802:
  394. /***/ ((module) => {
  395.  
  396. module.exports = Mousetrap;
  397.  
  398. /***/ })
  399.  
  400. /******/ 	});
  401. /************************************************************************/
  402. /******/ 	// The module cache
  403. /******/ 	var __webpack_module_cache__ = {};
  404. /******/ 	
  405. /******/ 	// The require function
  406. /******/ 	function __webpack_require__(moduleId) {
  407. /******/ 		// Check if module is in cache
  408. /******/ 		var cachedModule = __webpack_module_cache__[moduleId];
  409. /******/ 		if (cachedModule !== undefined) {
  410. /******/ 			return cachedModule.exports;
  411. /******/ 		}
  412. /******/ 		// Create a new module (and put it into the cache)
  413. /******/ 		var module = __webpack_module_cache__[moduleId] = {
  414. /******/ 			// no module.id needed
  415. /******/ 			// no module.loaded needed
  416. /******/ 			exports: {}
  417. /******/ 		};
  418. /******/ 	
  419. /******/ 		// Execute the module function
  420. /******/ 		__webpack_modules__[moduleId].call(module.exports, module, module.exports, __webpack_require__);
  421. /******/ 	
  422. /******/ 		// Return the exports of the module
  423. /******/ 		return module.exports;
  424. /******/ 	}
  425. /******/ 	
  426. /************************************************************************/
  427. /******/ 	
  428. /******/ 	// startup
  429. /******/ 	// Load entry module and return exports
  430. /******/ 	// This entry module is referenced by other modules so it can't be inlined
  431. /******/ 	var __webpack_exports__ = __webpack_require__(519);
  432. /******/ 	
  433. /******/ })()
  434. ;