Merge pull request #36 from bcgsc/release/v4.1.1

Release/v4.1.1

Author: mathieulemieux

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@bcgsc-pori/graphkb-schema",
-  "version": "4.1.0",
+  "version": "4.1.1",
   "description": "Shared package between the API and GUI for GraphKB which holds the schema definitions and schema-related functions",
   "bugs": {
     "email": "graphkb@bcgsc.ca"

package.json

@@ -46,12 +46,14 @@ const addEvidence = (
     record: StatementRecord,
     keys = TEMPLATE_KEYS,
 ) => {
-    // remove preexisting evidence info, if any
-    let updated = template.replace(' (${keys.evidenceLevel})', '');
-    updated = template.replace(' (${keys.evidence})', '');
-    updated = template.replace(' ${keys.preclinicalWarning}', '');
+    // remove preexisting evidence info, if any, e.g. from default template
+    let updated = template
+        .replace(` (${keys.evidenceLevel})`, '')
+        .replace(` (${keys.evidence})`, '')
+        .replace(` ${keys.preclinicalWarning}`, '');
 
     // preclinical warning
+    // eslint-disable-next-line one-var
     let isPreclinical = false;
 
     if (record.evidenceLevel) {
@@ -368,6 +370,7 @@ const generateStatementSentence = (
 };
 
 export {
+    addEvidence,
     generateStatementSentence,
     chooseDefaultTemplate,
     DEFAULT_TEMPLATE,

src/sentenceTemplates.ts

@@ -1,5 +1,10 @@
 import { schema } from '../src';
-import { DEFAULT_TEMPLATE, generateStatementSentence, PRECLINICAL_WARNING } from '../src/sentenceTemplates';
+import {
+    addEvidence,
+    DEFAULT_TEMPLATE,
+    generateStatementSentence,
+    PRECLINICAL_WARNING,
+} from '../src/sentenceTemplates';
 
 import examples from './testData/statementExamples.json';
 
@@ -332,3 +337,27 @@ describe('generateStatementSentence', () => {
         });
     });
 });
+
+describe('addEvidence', () => {
+    test('evidence', () => {
+        const updatedTemplate = addEvidence(DEFAULT_TEMPLATE, examples['evidence']);
+        const expected = 'Given {conditions}, {relevance} applies to {subject} ({evidence})'
+        expect(updatedTemplate).toEqual(expected);
+    });
+    test('evidenceLevel', () => {
+        const updatedTemplate = addEvidence(DEFAULT_TEMPLATE, examples['evidenceLevel']);
+        const expected = 'Given {conditions}, {relevance} applies to {subject} ({evidence}) ({evidenceLevel})'
+        expect(updatedTemplate).toEqual(expected);
+    });
+    test('preclinical warning', () => {
+        const updatedTemplate = addEvidence(DEFAULT_TEMPLATE, examples['preclinicalWarning']);
+        const expected = 'Given {conditions}, {relevance} applies to {subject} {preclinicalWarning} ({evidence}) ({evidenceLevel})'
+        expect(updatedTemplate).toEqual(expected);
+    });
+    test('remove preexisting evidence info', () => {
+        const template = '... {preclinicalWarning} ({evidence}) ({evidenceLevel})'
+        const updatedTemplate = addEvidence(template, examples['evidence']);
+        const expected = '... ({evidence})'
+        expect(updatedTemplate).toEqual(expected);
+    });
+});