@reality.eth/reality-eth-lib 3.1.15 → 3.2.0

package/formatters/question.js

@@ -7,6 +7,8 @@ const vsprintf = require("sprintf-js").vsprintf
 const QUESTION_MAX_OUTCOMES = 128;
 const marked = require('marked');
 const DOMPurify = require('isomorphic-dompurify');
+const { convert} = require('html-to-text');
+marked.setOptions({headerIds: false});
 
 exports.delimiter = function() {
     return '\u241f'; // Thought about '\u0000' but it seems to break something;
@@ -190,17 +192,16 @@ exports.parseQuestionJSON = function(data, errors_to_title) {
         };
     }
 
-    if (question_json['outcomes'] && question_json['outcomes'].length > QUESTION_MAX_OUTCOMES)
-        if(question_json['errors'])
-            question_json['errors']['too_many_outcomes'] = true
-        else
-            question_json['errors'] = {'too_many_outcomes': true};
-    if ('type' in question_json && question_json['type'] == 'datetime' && 'precision' in question_json) 
-        if (!(['Y', 'm', 'd', 'H', 'i', 's'].includes(question_json['precision'])))
-            if(question_json['errors'])
-                question_json['errors']['invalid_precision'] = true
-            else
-                question_json['errors'] = {'invalid_precision': true};
+    if (question_json['outcomes'] && question_json['outcomes'].length > QUESTION_MAX_OUTCOMES) {
+        if (!question_json['errors']) question_json['errors'] = {};
+        question_json['errors']['too_many_outcomes'] = true;
+    }
+    if ('type' in question_json && question_json['type'] == 'datetime' && 'precision' in question_json) {
+        if (!(['Y', 'm', 'd', 'H', 'i', 's'].includes(question_json['precision']))) {
+            if (!question_json['errors']) question_json['errors'] = {};
+            question_json['errors']['invalid_precision'] = true;
+        }
+    }
     // If errors_to_title is specified, we add any error message to the title to make sure we don't lose it
     if (errors_to_title) {
         if ('errors' in question_json) {
@@ -216,34 +217,31 @@ exports.parseQuestionJSON = function(data, errors_to_title) {
         }
     }
 
-    try{
-        switch(question_json['format']){
-            case 'text/markdown':{
-                const safeMarkdown = DOMPurify.sanitize(question_json['title'], { USE_PROFILES: {html: false}});
-                if (safeMarkdown !== question_json['title'])
-                    if(question_json['errors'])
-                        question_json['errors']['unsafe_markdown'] = true;
-                    else
-                        question_json['errors'] = {'unsafe_markdown': true};
-                else
-                    question_json['title-markdown-html'] = marked.parse(safeMarkdown).replace(/<img.*src=\"(.*?)\".*alt=\"(.*?)\".*\/?>/, '<a href="$1">$2</a>');
-                break;
-            }
-            case 'text/plain': {
-                break;
-            }
-            case undefined:{
-                question_json['format'] = 'text/plain';
-                break;
-            }
-            default:{
-                question_json['errors'] = {'invalid_format': true};            
-                break;
+    if (!question_json['format']) {
+        question_json['format'] = 'text/plain';
+    }
+
+    if (question_json['format'] == 'text/plain') {
+        question_json['title_text'] = question_json['title'];
+    } else if (question_json['format'] == 'text/markdown') {
+        try{
+            const safeMarkdown = DOMPurify.sanitize(question_json['title'], { USE_PROFILES: {html: false}});
+            if (safeMarkdown !== question_json['title']) {
+                if (!question_json['errors']) question_json['errors'] = {};
+                question_json['errors']['unsafe_markdown'] = true;
+            } else {
+                question_json['title_html'] = marked.parse(safeMarkdown).replace(/<img.*src=\"(.*?)\".*alt=\"(.*?)\".*\/?>/, '<a href="$1">$2</a>');
+                question_json['title_text'] = convert(question_json['title_html'], {
+                    selectors: [{selector: 'h1', options: { uppercase: false }}, {selector: 'h2', options: { uppercase: false }}]
+                });
             }
-        }
-    } catch(e){
-        if(question_json && question_json['errors'])
+        } catch(e){
+            if (!question_json['errors']) question_json['errors'] = {};
             question_json['errors']['markdown_parse_failed'] = true
+        }
+    } else {
+        if (!question_json['errors']) question_json['errors'] = {};
+        question_json['errors']['invalid_format'] = true;
     }
 
     // If errors_to_title is specified, we add any error message to the title to make sure we don't lose it

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reality.eth/reality-eth-lib",
-  "version": "3.1.15",
+  "version": "3.2.0",
   "description": "Tools for handling questions in the reality.eth fact verification platform",
   "scripts": {
     "test": "env TZ='Asia/Kabul' mocha ./test"
@@ -16,10 +16,11 @@
   "author": "Edmund Edgar (https://reality.eth.link)",
   "license": "GPL-3.0",
   "dependencies": {
-    "@reality.eth/contracts": "^3.0.16",
+    "@reality.eth/contracts": "^3.0.17",
     "bignumber.js": "^7.2.1",
     "bn.js": "^5.2.1",
     "ethereumjs-abi": "^0.6.5",
+    "html-to-text": "^8.2.1",
     "isomorphic-dompurify": "^0.23.0",
     "marked": "^4.1.1",
     "sprintf-js": "^1.1.1"
@@ -38,5 +39,5 @@
     "url": "https://github.com/RealityETH/monorepo/issues"
   },
   "homepage": "https://reality.eth.link",
-  "gitHead": "5b0b4dd179e68567d2a0086fc10a6d0f9967af47"
+  "gitHead": "1962e3224fbde8811b888a731e714c8bd23b42f7"
 }

package/test/formatters.js

@@ -240,6 +240,66 @@ describe('Broken questions', function() {
   });
 });
 
+describe('Markdown questions', function() {
+  it('Sets title, title_html and title_text appropriatly', function() {
+    const qMarkdown = "{\"title\": \"# my title oh yes\", \"type\": \"bool\", \"category\": \"art\", \"lang\": \"en_US\", \"format\": \"text/markdown\"}";
+    const q = rc_question.parseQuestionJSON(qMarkdown, true);
+    expect(q.errors).to.equal(undefined);
+    expect(q.format).to.equal('text/markdown');
+    expect(q.title_text).to.equal('my title oh yes');
+    expect(q.title).to.equal('# my title oh yes');
+    expect(q.title_html).to.equal('<h1>my title oh yes</h1>'+"\n");
+  });
+  it('Set title_text appropriatly for italic and bold headings', function() {
+    const qMarkdown = "{\"title\": \"# _Italic Heading 1_\\n## __Bold Heading 2__\", \"type\": \"bool\", \"category\": \"art\", \"lang\": \"en_US\", \"format\": \"text/markdown\"}";
+    const q = rc_question.parseQuestionJSON(qMarkdown, true);
+    expect(q.errors).to.equal(undefined);
+    expect(q.format).to.equal('text/markdown');
+    expect(q.title_text).to.equal('Italic Heading 1\n\n\nBold Heading 2');
+    expect(q.title).to.equal('# _Italic Heading 1_\n## __Bold Heading 2__');
+    expect(q.title_html).to.equal(`<h1><em>Italic Heading 1</em></h1>\n<h2><strong>Bold Heading 2</strong></h2>`+"\n");
+  });
+  it('Set title_text appropriatly for italic and bold quotes', function() {
+    const qMarkdown = "{\"title\": \">_Italic_ __Bold__\", \"type\": \"bool\", \"category\": \"art\", \"lang\": \"en_US\", \"format\": \"text/markdown\"}";
+    const q = rc_question.parseQuestionJSON(qMarkdown, true);
+    expect(q.errors).to.equal(undefined);
+    expect(q.format).to.equal('text/markdown');
+    expect(q.title_text).to.equal('> Italic Bold');
+    expect(q.title).to.equal('>_Italic_ __Bold__');
+    expect(q.title_html).to.equal('<blockquote>\n<p><em>Italic</em> <strong>Bold</strong></p>\n</blockquote>'+"\n");
+  });
+    it('Set title_text appropriatly for lists', function() {
+    const qMarkdown = "{\"title\": \"* __Item One__\\n* __Item Two__\\n* __Item Three__\\n1. Item One\\n2. Item Two\\n3. Item Three\", \"type\": \"bool\", \"category\": \"art\", \"lang\": \"en_US\", \"format\": \"text/markdown\"}";
+    const q = rc_question.parseQuestionJSON(qMarkdown, true);
+    expect(q.errors).to.equal(undefined);
+    expect(q.format).to.equal('text/markdown');
+    expect(q.title_text).to.equal(' * Item One\n * Item Two\n * Item Three\n\n 1. Item One\n 2. Item Two\n 3. Item Three');
+    expect(q.title).to.equal('* __Item One__\n* __Item Two__\n* __Item Three__\n1. Item One\n2. Item Two\n3. Item Three');
+    expect(q.title_html).to.equal(
+`<ul>
+<li><strong>Item One</strong></li>
+<li><strong>Item Two</strong></li>
+<li><strong>Item Three</strong></li>
+</ul>
+<ol>
+<li>Item One</li>
+<li>Item Two</li>
+<li>Item Three</li>
+</ol>` + "\n");
+  });
+  it('Set title_text appropriatly for code blocks', function() {
+    const qMarkdown = "{\"title\": \"`Inline code` with backticks\\n\\n```# code block\\nprint '3 backticks or'\\nprint 'indent 4 spaces'```\", \"type\": \"bool\", \"category\": \"art\", \"lang\": \"en_US\", \"format\": \"text/markdown\"}";
+    const q = rc_question.parseQuestionJSON(qMarkdown, true);
+    expect(q.errors).to.equal(undefined);
+    expect(q.format).to.equal('text/markdown');
+    expect(q.title_text).to.equal(`Inline code with backticks\n\n# code block print '3 backticks or' print 'indent 4 spaces'`);
+    expect(q.title).to.equal("`Inline code` with backticks\n\n```# code block\nprint '3 backticks or'\nprint 'indent 4 spaces'```");
+    expect(q.title_html).to.equal(
+`<p><code>Inline code</code> with backticks</p>
+<p><code># code block print &#39;3 backticks or&#39; print &#39;indent 4 spaces&#39;</code></p>`+ "\n");
+  });
+});
+
 describe('Unsafe markdown questions', function() {
   it('Sets an error if a question includes unsafe html in markdown', function() {
     const qUnsafeMarkdown = "{\"title\": \"# Title <p>abc<iframe\/\/src=jAva&Tab;script:alert(3)>def<\/p>\", \"type\": \"bool\", \"category\": \"art\", \"lang\": \"en_US\", \"format\": \"text/markdown\"}";
@@ -247,8 +307,8 @@ describe('Unsafe markdown questions', function() {
     expect(q.errors.unsafe_markdown).to.equal(true);
   });
   it('Sets no error if a question includes valid markdown without html', function() {
-    const qUnsafeMarkdown = "{\"title\": \"# Title\", \"type\": \"bool\", \"category\": \"art\", \"lang\": \"en_US\", \"format\": \"text/markdown\"}";
-    const q = rc_question.parseQuestionJSON(qUnsafeMarkdown, true);
+    const qSafeMarkdown = "{\"title\": \"# Title\", \"type\": \"bool\", \"category\": \"art\", \"lang\": \"en_US\", \"format\": \"text/markdown\"}";
+    const q = rc_question.parseQuestionJSON(qSafeMarkdown, true);
     expect(q.errors).to.equal(undefined);
     expect(q.format).to.equal('text/markdown');
   });