formatting.js

  1. /**
  2.  * Provides a number of functions for formatting text, cards and decks on Slack using the Slack API and Markdown.
  3.  * @module  formating
  4.  * @author  Dominic Shelton.
  5.  */
  6. 'use strict';
  8. /**
  9.  * @var {object} colours
  10.  * The faction colours are loaded from a JSON file.
  11.  */
  12. var colours = require('./colours.json');
  13. /**
  14.  * @var {string[]|string[][]} packs 
  15.  * The pack and cycle names are loaded from a JSON file.
  16.  */
  17. var packs = require('./datapacks.json');
  18. /**
  19.  * @var {module} alliances
  20.  * The {@link alliances} module is required for calculating the decklist influence total.
  21.  */
  22. var alliances = require('./alliances.js');
  23. /**
  24.  * @var {string} thumbsURL
  25.  * The URL where the card thumbnails are hosted, loaded from the environment variable THUMBS_URL
  26.  */
  27. var thumbsURL = process.env.THUMBS_URL;
  28. /**
  29.  * @var {object}  messages
  30.  * Various text messages conveniently combined into one object.
  31.  */
  32. var messages = {
  33.     noCardHits: [
  34.         "The run was successful but you didn't access _\u200b[cards]\u200b_.",
  35.         "I was unable to find _\u200b[cards]\u200b_ in any of my remotes.",
  36.         "Despite 822 Medium counters, _\u200b[cards]\u200b_ wasn't found.",
  37.         "The Near-Earth Hub couldn't locate _\u200b[cards]\u200b_."
  38.     ],
  39.     noDeckHits: [
  40.         "The archetype of that deck would be _\u200bnon-existant\u200b_."
  41.     ],
  42.     helpBrackets:
  43.         "Search for a card by (partial) name, or acronym, or a decklist by its netrunnerdb link e.g.\`\`\`[sneakdoor] [hiemdal] [etf]\n[netrunnerdb\u200b.com/en/decklist/17055/example]\`\`\`",
  44.     helpDeck:
  45.         "Search for a decklist by its netrunnerdb link or ID number e.g.\`\`\`[command] 12345, [command] netrunnerdb\u200b.com/en/decklist/17055/example\`\`\`",
  46.     helpCard:
  47.         "Search for a card by (partial) name, approximation or acronym e.g.\`\`\`[command]sneakdoor, [command]hiemdal, [command]etf\`\`\`"
  48. };
  49. /**
  50.  * @var {string[][]}    headings
  51.  * Headings used in Decklists, in the order they appear in the decklist output.
  52.  */
  53. var headings = [
  54.     ['Event', 'Hardware', 'Resource', 'Agenda', 'Asset', 'Upgrade', 'Operation'],
  55.     ['Icebreaker', 'Program', 'Barrier', 'Code Gate', 'Sentry', 'Multi', 'Other']
  56. ];
  57. /**
  58.  * @var {string[][]}    stats
  59.  * An array of pairs of card stats and corresponding emoji, in the order they should appear in card descriptions.
  60.  */
  61. var stats = [
  62.     ['baselink', ' :_link:'],
  63.     ['cost', ':_credit:'],
  64.     ['memoryunits', ' :_mu:'],
  65.     ['strength', ' str'],
  66.     ['trash', ' :_trash:'],
  67.     ['advancementcost', ' :_advance:'],
  68.     ['minimumdecksize', ' :_deck:'],
  69.     ['influencelimit', '•'],
  70.     ['agendapoints', ' :_agenda:']
  71. ];
  73. /**
  74.  * @func cardHelpMessage
  75.  * @param   command {string}    The Slack command that was used to invoke the help request, used in the examples returned. Can be left blank to invoke the fallback brackets help text.
  76.  * @return  {object}    A Slack API message object of a help response message.
  77.  */
  78. module.exports.cardHelpMessage = cardHelpMessage;
  79. function cardHelpMessage(command) {
  80.     if (command) {
  81.         return {
  82.             text: messages.helpCard.replace(/\[command\]/g, command + ' ')
  83.         };
  84.     }
  85.     return {
  86.         text: messages.helpBrackets
  87.     };
  88. };
  90. /**
  91.  * @func deckHelpMessage
  92.  * @param   command {string}    The Slack command that was used to invoke the help request, used in the examples returned.
  93.  * @return  {object}    A Slack API message object of a help response message.
  94.  */
  95. module.exports.deckHelpMessage = deckHelpMessage;
  96. function deckHelpMessage(command) {
  97.     return {
  98.         text: messages.helpDeck.replace(/\[command\]/g, command)
  99.     };
  100. };
  102. /**
  103.  * Generates a message indicating that cards weren't found, by concatenating the names with commas and 'or'
  104.  * @func cardNoHitsMessage
  105.  * @param   cards   {string[]}  An array of card titles that weren't found.
  106.  * @return  {string}    A randomized Slack API message object stating that the given cards weren't found.
  107.  */
  108. module.exports.cardNoHitsMessage = cardNoHitsMessage;
  109. function cardNoHitsMessage(cards) {
  110.     var text;
  111.     if (cards.length >= 2) {
  112.         text = cards.slice(0, cards.length - 1).join(', ');
  113.         text += ' or ' + cards[cards.length - 1];
  114.     } else {
  115.         text = cards[0];
  116.     }
  117.     var message = getCardNoHitsMessage(text);
  118.     return {
  119.         text: message
  120.     };
  121. };
  123. /**
  124.  * Generates a message indicating that a deck wasn't found.
  125.  * @func deckNoHitsMessage
  126.  * @return  {string}    A randomized Slack API message object stating that the deck wasn't found.
  127.  */
  128. module.exports.deckNoHitsMessage = deckNoHitsMessage;
  129. function deckNoHitsMessage() {
  130.     var r = Math.floor(Math.random() * messages.noDeckHits.length);
  131.     return {
  132.         text: messages.noDeckHits[r]
  133.     };
  134. };
  136. /**
  137.  * Applies Slack markdown formatting to the given title to bolden and optionally apply the link.
  138.  * @func    formatTitle
  139.  * @param   title   {string}    The text to display as the title.
  140.  * @param   [url]   {string}    The URL to link the title to.
  141.  * @return  {string}    A string containing the title with Slack markdown formatting applied.
  142.  */
  143. module.exports.formatTitle = formatTitle;
  144. function formatTitle(title, url) {
  145.     title = '*\u200b' + title + '\u200b*';
  146.     if (url && url !== '') {
  147.         return formatLink(title, url);
  148.     }
  149.     return title;
  150. };
  152. /**
  153.  * @func    formatDecklist
  154.  * @param   decklist    {object}    The decklist to be converted into a Slack message.
  155.  * @return  {object}    A Slack API message object containing the decklist or an error message.
  156.  */
  157. module.exports.formatDecklist = (decklist) => {
  158.     // Initialise the return object.
  159.     var o = {text: '', attachments:[{mrkdwn_in: ['pretext', 'fields']}]};
  160.     var faction = decklist.cards.Identity[0].card.faction;
  161.     var usedInfluence = 0;
  162.     var mwlDeduction = 0;
  163.     var decksize = 0;
  164.     var agendapoints = 0;
  165.     var fields = [];
  166.     // Initialise the newestCard var to a card that is guaranteed to be in every deck.
  167.     var newestCard = parseInt(decklist.cards.Identity[0].card.code);
  168.     o.text = formatTitle(decklist.name, decklist.url);
  169.     o.text += ' - _\u200b' + decklist.creator + '\u200b_';
  170.     for (let column in headings) {
  171.         // Create the columns as Slack 'fields'.
  172.         fields[column] = {title: '', value: '', short: true};
  173.         for (let heading in headings[column]) {
  174.             var type = headings[column][heading];
  175.             // Check if the deck actually contains cards of the specified heading
  176.             if (decklist.cards[type]) {
  177.                 var typeTotal = 0;
  178.                 var text = '';
  179.                 // Iterate through all the cards of the type in the decklist.
  180.                 for (let i in decklist.cards[type]) {
  181.                     var card = decklist.cards[type][i];
  182.                     var code = parseInt(card.card.code);
  183.                     typeTotal += card.quantity;
  184.                     text += '\n' + card.quantity;
  185.                     text += ' × ' + formatLink(card.card.title, card.card.url);
  186.                     decksize += card.quantity;
  187.                     // Check that the card is not newer than the previous newest card.
  188.                     if (code > newestCard) {
  189.                         newestCard = code;
  190.                     }
  191.                     if (card.card.agendapoints) {
  192.                         agendapoints += card.card.agendapoints * card.quantity;
  193.                     }
  194.                     // Add MWL star if required.
  195.                     if (card.card.mwl)
  196.                     {
  197.                         var mwl = card.quantity * card.card.mwl;
  198.                         text += ' ' + '☆'.repeat(mwl);
  199.                         mwlDeduction += mwl;
  200.                     }
  201.                     // Add influence dots after the card name if required.
  202.                     if (card.card.faction !== faction) {
  203.                         var inf = card.quantity * card.card.factioncost;
  204.                         if (alliances[card.card.code]) {
  205.                             inf *= alliances[card.card.code](decklist);
  206.                         }
  207.                         text += ' ' + influenceDots(inf);
  208.                         usedInfluence += inf;
  209.                     }
  210.                 }
  211.                 // If this is not the first heading, add padding after the previous.
  212.                 if (heading != 0) {
  213.                     fields[column].value += '\n\n';
  214.                 }
  215.                 fields[column].value += formatTitle(type) + ' (' + typeTotal + ')';
  216.                 fields[column].value += text;
  217.             }
  218.         }
  219.     }
  220.     o.attachments[0].color = colours[faction];
  221.     o.attachments[0].fields = fields;
  222.     // The identity of the decklist is displayed before the decklist.
  223.     o.attachments[0].pretext = formatLink(decklist.cards.Identity[0].card.title,
  224.             decklist.cards.Identity[0].card.url);
  225.     o.attachments[0].pretext += '\n' + decksize + ' :_deck: (min ';
  226.     o.attachments[0].pretext +=  decklist.cards.Identity[0].card.minimumdecksize;
  227.     o.attachments[0].pretext += ') - ' + usedInfluence + '/';
  228.     if (decklist.cards.Identity[0].card.influencelimit) {
  229.         o.attachments[0].pretext += decklist.cards.Identity[0].card.influencelimit - mwlDeduction + '•';
  230.         if (mwlDeduction > 0) {
  231.             o.attachments[0].pretext += '(' + decklist.cards.Identity[0].card.influencelimit + '-';
  232.             o.attachments[0].pretext += mwlDeduction + '☆)';
  233.         }
  234.     } else {
  235.         o.attachments[0].pretext += '∞•';
  236.     }
  237.     if (decklist.cards.Identity[0].card.side !== 'Runner') {
  238.         o.attachments[0].pretext += ' - ' + agendapoints + ' :_agenda:';
  239.     }
  240.     o.attachments[0].pretext += '\nCards up to ' + getPack(newestCard);
  241.     return o;
  242. };
  244. /**
  245.  * @func    formatCards
  246.  * @param   [cards] {object[]}  The cards to be converted into a Slack message.
  247.  * @param   [cards] {object[]}  The cards that weren't found and should be mentioned in an error message.
  248.  * @return  {object}    A Slack API Message object either containing the cards as attachments or containing an error message that the cards couldn't be found, or both.
  249.  */
  250. module.exports.formatCards = (cards, missing) => {
  251.     var o;
  252.     // If there are cards that could not be found, tell the user.
  253.     if (missing && missing.length > 0) {
  254.         o = cardNoHitsMessage(missing);
  255.         o.attachments = [];
  256.     } else {
  257.         o = {text:'', attachments:[]};
  258.     }
  259.     // Display the cards that were found either way.
  260.     for (var i = 0; i < cards.length; i++) {
  261.         var a = {pretext: '', mrkdwn_in: ['pretext', 'text']};
  262.         var faction = cards[i].faction;
  263.         var title = cards[i].title;
  264.         if (cards[i].uniqueness){
  265.             title = '◆ ' + title;
  266.         }
  267.         // If the Slack message is blank, put the title of the first card there.
  268.         // The Slack API won't display messages with blank text even when there are attachments.
  269.         if (o.text === '') {
  270.             o.text = formatTitle(title, cards[0].url);
  271.         } else {
  272.             a.pretext = formatTitle(title, cards[i].url) + '\n';
  273.         }
  274.         // Append the rest of the card details to the attachment.
  275.         a.pretext += '*\u200b' + cards[i].type;
  276.         if (cards[i].subtype ) {
  277.             a.pretext += ':\u200b* ' + cards[i].subtype;
  278.         } else {
  279.             a.pretext += '\u200b*';
  280.         }
  281.         a.pretext += ' - ' + getFactionEmoji(faction);
  282.         if (cards[i].factioncost) {
  283.             a.pretext += influenceDots(cards[i].factioncost);
  284.         }
  285.         if (cards[i].mwl) {
  286.             a.pretext += '☆';
  287.         }
  288.         a.pretext += '\n';
  289.         var first = true;
  290.         // For some cards, the cost is actually a rez cost, this should be reflected in the emoji.
  291.         if (cards[i].type === 'Asset' || cards[i].type === 'Upgrade' || cards[i].type === 'ICE') {
  292.             stats[1][1] = ' :_rez:';
  293.         } else {
  294.             stats[1][1] = ':_credit:';
  295.         }
  296.         // Iterate through the possible card stats adding them to the text where present.
  297.         for (var j = 0; j < stats.length; j++) {
  298.             if (cards[i][stats[j][0]] || cards[i][stats[j][0]] === 0) {
  299.                 if (!first) {
  300.                     a.pretext += ' - ';
  301.                 }
  302.                 a.pretext += cards[i][stats[j][0]] + stats[j][1];
  303.                 first = false;
  304.             // Special case for draft IDs with infinite influence limit
  305.             } else if (cards[i].type === 'Identity' && stats[j][0] === 'influencelimit' && !cards[i].influencelimit) {
  306.                 a.pretext += ' - ∞•';
  307.             }
  308.         }
  309.         // Replace memory units with the slack emoji
  310.         a.pretext = a.pretext.replace(/(\d|X)\s*:_mu:/gi, function (x) {
  311.             return x.replace(/(.).*/, ':_$1mu:').toLowerCase();
  312.         });
  313.         a.pretext += ' - ' + getPack(parseInt(cards[i].code));
  314.         a.color = colours[faction];
  315.         // Add the card text to the attachment if present.
  316.         if (cards[i].text) {
  317.             a.text = formatText(cards[i].text);
  318.         }
  319.         a.thumb_url = thumbsURL + cards[i].code + '.png';
  320.         o.attachments.push(a);
  321.     }
  322.     return o;
  323. };
  325. /**
  326.  * Replace all the html and nrdb text with the Slack equivalent.
  327.  * @func    formatText
  328.  * @param   text    {string}    The body of text to convert to Slack formatting.
  329.  * @return  {string}    The text, formatted in Slack markdown syntax.
  330.  */
  331. module.exports.formatText = formatText;
  332. function formatText(text) {
  333.     if (!text) return text;
  335.     text = text.replace(/\r\n/g, '\n');
  337.     // NRDB symbols to Slack emoji.
  338.     text = text.replace(/\[Credits\]/g, ':_credit:');
  339.     text = text.replace(/\[Recurring\ Credits\]/g, ':_recurringcredit:');
  340.     text = text.replace(/\[Click\]/g, ':_click:');
  341.     text = text.replace(/\ *\[Link\]/g, ' :_link:');
  342.     text = text.replace(/\[Trash\]/g, ':_trash:');
  343.     text = text.replace(/\[Subroutine\]/g, ':_subroutine:');
  344.     // Individual mu emoji for numbers and 'Xmu'
  345.     text = text.replace(/(\d|X)\s*\[Memory\ Unit\]/gi, function (x) {
  346.         return x.replace(/(.).*/, ':_$1mu:').toLowerCase();
  347.     });
  348.     text = text.replace(/\[Memory Unit\]/g, ':_mu:');
  350.     // HTML bold to Slack bold
  351.     text = text.replace(/<strong>/g, '*\u200b');
  352.     text = text.replace(/<\/strong>/g, '\u200b*');
  353.     // HTML superscript to unicode superscript since Slack markdown doesn't support it.
  354.     text = text.replace(/<sup>(?:\d|X)+<\/sup>/gi, function(x){
  355.         x = x.replace(/<sup>|<\/sup>/g, '');
  356.         x = x.replace(/X/i,'ˣ');
  357.         x = x.replace(/\d/g, function(d){
  358.             return ['⁰','¹','²','³','⁴','⁵','⁶','⁷','⁸','⁹'][parseInt(d)];
  359.         });
  360.         return x;
  361.     });
  363.     // Replace nrdb faction symbols with Slack emoji
  364.     text = text.replace(/\[(jinteki|weyland-consortium|nbn|haas-bioroid)\]/, (a, x) => {
  365.         return ":_" + getFactionEmoji(x) + ":";
  366.     });
  368.     text = text.replace(/&/g, '&amp;');
  369.     text = text.replace(/</g, '&lt;');
  370.     text = text.replace(/>/g, '&gt;');
  372.     return text;
  373. };
  375. function influenceDots(influence) {
  376.     return '•'.repeat(influence);
  377. }
  379. function getPack(code) {
  380.     var cycle = packs[Math.floor(code/1000)];
  381.     if (Array.isArray(cycle)) {
  382.         cycle = cycle[Math.floor(((code % 1000) - 1) / 20)];
  383.     }
  384.     return '_\u200b' + cycle + '\u200b_';
  385. }
  387. function formatLink(text, url) {
  388.     return '<' + url + '|' + text + '>';
  389. }
  391. function getFactionEmoji(faction) {
  392.     return ':_' + faction.replace(/\s.*/, '').toLowerCase() + ':';
  393. }
  395. function getCardNoHitsMessage(text) {
  396.     var r = Math.floor(Math.random() * messages.noCardHits.length);
  397.     return messages.noCardHits[r].replace(/\[cards\]/g, text);
  398. }