@defra/forms-model 3.0.503 → 3.0.504

package/dist/module/utils/markdown.js

@@ -1,4 +1,4 @@
-import { Marked } from 'marked';
+import { Marked, Renderer } from 'marked';
 
 /**
  * Marked instance (avoids global option/extension scope)
@@ -7,17 +7,37 @@ export const marked = new Marked({
   breaks: true,
   gfm: true
 });
+function renderLink(href, text, baseUrl) {
+  let isLocalLink = true;
+  if (baseUrl) {
+    isLocalLink = href.startsWith(baseUrl) || href.startsWith('mailto:');
+  }
+  const attrs = [`class="govuk-link"`, `href="${href}"`];
+  if (!isLocalLink) {
+    attrs.push(`target="_blank" rel="noreferrer noopener"`);
+  }
+  const label = !isLocalLink ? `${text} (opens in new tab)` : text;
+  return `<a ${attrs.join(' ')}>${label}</a>`;
+}
 
 /**
  * Convert markdown to HTML, escaping any HTML tags first
  */
-export function markdownToHtml(markdown) {
+export function markdownToHtml(markdown, baseUrl) {
   if (markdown === undefined || markdown === null) {
     return '';
   }
   const escaped = markdown.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;').replace(/'/g, '&#39;');
+  const renderer = new Renderer();
+  renderer.link = ({
+    href,
+    text
+  }) => {
+    return renderLink(href, text, baseUrl);
+  };
   return marked.parse(escaped, {
-    async: false
+    async: false,
+    renderer
   });
 }
 //# sourceMappingURL=markdown.js.map

package/dist/module/utils/markdown.js.map

@@ -1 +1 @@
-{"version":3,"file":"markdown.js","names":["Marked","marked","breaks","gfm","markdownToHtml","markdown","undefined","escaped","replace","parse","async"],"sources":["../../../src/utils/markdown.ts"],"sourcesContent":["import { Marked } from 'marked'\n\n/**\n * Marked instance (avoids global option/extension scope)\n */\nexport const marked = new Marked({\n  breaks: true,\n  gfm: true\n})\n\n/**\n * Convert markdown to HTML, escaping any HTML tags first\n */\nexport function markdownToHtml(markdown?: string | null) {\n  if (markdown === undefined || markdown === null) {\n    return ''\n  }\n\n  const escaped = markdown\n    .replace(/&/g, '&amp;')\n    .replace(/</g, '&lt;')\n    .replace(/>/g, '&gt;')\n    .replace(/\"/g, '&quot;')\n    .replace(/'/g, '&#39;')\n\n  return marked.parse(escaped, { async: false })\n}\n"],"mappings":"AAAA,SAASA,MAAM,QAAQ,QAAQ;;AAE/B;AACA;AACA;AACA,OAAO,MAAMC,MAAM,GAAG,IAAID,MAAM,CAAC;EAC/BE,MAAM,EAAE,IAAI;EACZC,GAAG,EAAE;AACP,CAAC,CAAC;;AAEF;AACA;AACA;AACA,OAAO,SAASC,cAAcA,CAACC,QAAwB,EAAE;EACvD,IAAIA,QAAQ,KAAKC,SAAS,IAAID,QAAQ,KAAK,IAAI,EAAE;IAC/C,OAAO,EAAE;EACX;EAEA,MAAME,OAAO,GAAGF,QAAQ,CACrBG,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CACtBA,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CACrBA,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CACrBA,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CACvBA,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC;EAEzB,OAAOP,MAAM,CAACQ,KAAK,CAACF,OAAO,EAAE;IAAEG,KAAK,EAAE;EAAM,CAAC,CAAC;AAChD","ignoreList":[]}
+{"version":3,"file":"markdown.js","names":["Marked","Renderer","marked","breaks","gfm","renderLink","href","text","baseUrl","isLocalLink","startsWith","attrs","push","label","join","markdownToHtml","markdown","undefined","escaped","replace","renderer","link","parse","async"],"sources":["../../../src/utils/markdown.ts"],"sourcesContent":["import { Marked, Renderer, type Tokens } from 'marked'\n\n/**\n * Marked instance (avoids global option/extension scope)\n */\nexport const marked = new Marked({\n  breaks: true,\n  gfm: true\n})\n\nfunction renderLink(href: string, text: string, baseUrl?: string) {\n  let isLocalLink = true\n\n  if (baseUrl) {\n    isLocalLink = href.startsWith(baseUrl) || href.startsWith('mailto:')\n  }\n\n  const attrs = [`class=\"govuk-link\"`, `href=\"${href}\"`]\n\n  if (!isLocalLink) {\n    attrs.push(`target=\"_blank\" rel=\"noreferrer noopener\"`)\n  }\n\n  const label = !isLocalLink ? `${text} (opens in new tab)` : text\n\n  return `<a ${attrs.join(' ')}>${label}</a>`\n}\n\n/**\n * Convert markdown to HTML, escaping any HTML tags first\n */\nexport function markdownToHtml(\n  markdown: string | null | undefined,\n  baseUrl?: string // optional in some contexts, e.g. from the designer where it might not make sense\n) {\n  if (markdown === undefined || markdown === null) {\n    return ''\n  }\n\n  const escaped = markdown\n    .replace(/&/g, '&amp;')\n    .replace(/</g, '&lt;')\n    .replace(/>/g, '&gt;')\n    .replace(/\"/g, '&quot;')\n    .replace(/'/g, '&#39;')\n\n  const renderer = new Renderer()\n  renderer.link = ({ href, text }: Tokens.Link): string => {\n    return renderLink(href, text, baseUrl)\n  }\n\n  return marked.parse(escaped, { async: false, renderer })\n}\n"],"mappings":"AAAA,SAASA,MAAM,EAAEC,QAAQ,QAAqB,QAAQ;;AAEtD;AACA;AACA;AACA,OAAO,MAAMC,MAAM,GAAG,IAAIF,MAAM,CAAC;EAC/BG,MAAM,EAAE,IAAI;EACZC,GAAG,EAAE;AACP,CAAC,CAAC;AAEF,SAASC,UAAUA,CAACC,IAAY,EAAEC,IAAY,EAAEC,OAAgB,EAAE;EAChE,IAAIC,WAAW,GAAG,IAAI;EAEtB,IAAID,OAAO,EAAE;IACXC,WAAW,GAAGH,IAAI,CAACI,UAAU,CAACF,OAAO,CAAC,IAAIF,IAAI,CAACI,UAAU,CAAC,SAAS,CAAC;EACtE;EAEA,MAAMC,KAAK,GAAG,CAAC,oBAAoB,EAAE,SAASL,IAAI,GAAG,CAAC;EAEtD,IAAI,CAACG,WAAW,EAAE;IAChBE,KAAK,CAACC,IAAI,CAAC,2CAA2C,CAAC;EACzD;EAEA,MAAMC,KAAK,GAAG,CAACJ,WAAW,GAAG,GAAGF,IAAI,qBAAqB,GAAGA,IAAI;EAEhE,OAAO,MAAMI,KAAK,CAACG,IAAI,CAAC,GAAG,CAAC,IAAID,KAAK,MAAM;AAC7C;;AAEA;AACA;AACA;AACA,OAAO,SAASE,cAAcA,CAC5BC,QAAmC,EACnCR,OAAgB,EAChB;EACA,IAAIQ,QAAQ,KAAKC,SAAS,IAAID,QAAQ,KAAK,IAAI,EAAE;IAC/C,OAAO,EAAE;EACX;EAEA,MAAME,OAAO,GAAGF,QAAQ,CACrBG,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CACtBA,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CACrBA,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CACrBA,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CACvBA,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC;EAEzB,MAAMC,QAAQ,GAAG,IAAInB,QAAQ,CAAC,CAAC;EAC/BmB,QAAQ,CAACC,IAAI,GAAG,CAAC;IAAEf,IAAI;IAAEC;EAAkB,CAAC,KAAa;IACvD,OAAOF,UAAU,CAACC,IAAI,EAAEC,IAAI,EAAEC,OAAO,CAAC;EACxC,CAAC;EAED,OAAON,MAAM,CAACoB,KAAK,CAACJ,OAAO,EAAE;IAAEK,KAAK,EAAE,KAAK;IAAEH;EAAS,CAAC,CAAC;AAC1D","ignoreList":[]}

package/dist/types/utils/markdown.d.ts

@@ -6,5 +6,5 @@ export declare const marked: Marked;
 /**
  * Convert markdown to HTML, escaping any HTML tags first
  */
-export declare function markdownToHtml(markdown?: string | null): string;
+export declare function markdownToHtml(markdown: string | null | undefined, baseUrl?: string): string;
 //# sourceMappingURL=markdown.d.ts.map

package/dist/types/utils/markdown.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../../src/utils/markdown.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAE/B;;GAEG;AACH,eAAO,MAAM,MAAM,QAGjB,CAAA;AAEF;;GAEG;AACH,wBAAgB,cAAc,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,UAatD"}
+{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../../src/utils/markdown.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAyB,MAAM,QAAQ,CAAA;AAEtD;;GAEG;AACH,eAAO,MAAM,MAAM,QAGjB,CAAA;AAoBF;;GAEG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE,MAAM,UAmBjB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-model",
-  "version": "3.0.503",
+  "version": "3.0.504",
   "description": "A hapi plugin providing the model for Defra forms",
   "homepage": "https://github.com/DEFRA/forms-designer/tree/main/model#readme",
   "types": "dist/types/index.d.ts",

package/src/utils/markdown.ts

@@ -1,4 +1,4 @@
-import { Marked } from 'marked'
+import { Marked, Renderer, type Tokens } from 'marked'
 
 /**
  * Marked instance (avoids global option/extension scope)
@@ -8,10 +8,31 @@ export const marked = new Marked({
   gfm: true
 })
 
+function renderLink(href: string, text: string, baseUrl?: string) {
+  let isLocalLink = true
+
+  if (baseUrl) {
+    isLocalLink = href.startsWith(baseUrl) || href.startsWith('mailto:')
+  }
+
+  const attrs = [`class="govuk-link"`, `href="${href}"`]
+
+  if (!isLocalLink) {
+    attrs.push(`target="_blank" rel="noreferrer noopener"`)
+  }
+
+  const label = !isLocalLink ? `${text} (opens in new tab)` : text
+
+  return `<a ${attrs.join(' ')}>${label}</a>`
+}
+
 /**
  * Convert markdown to HTML, escaping any HTML tags first
  */
-export function markdownToHtml(markdown?: string | null) {
+export function markdownToHtml(
+  markdown: string | null | undefined,
+  baseUrl?: string // optional in some contexts, e.g. from the designer where it might not make sense
+) {
   if (markdown === undefined || markdown === null) {
     return ''
   }
@@ -23,5 +44,10 @@ export function markdownToHtml(markdown?: string | null) {
     .replace(/"/g, '&quot;')
     .replace(/'/g, '&#39;')
 
-  return marked.parse(escaped, { async: false })
+  const renderer = new Renderer()
+  renderer.link = ({ href, text }: Tokens.Link): string => {
+    return renderLink(href, text, baseUrl)
+  }
+
+  return marked.parse(escaped, { async: false, renderer })
 }