☰

Kanka.io Keybinds

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

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

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