@defra/forms-model 3.0.636 → 3.0.637

package/dist/module/utils/markdown.js

@@ -5,18 +5,49 @@ import { Marked, Renderer } from 'marked';
  */
 export const marked = new Marked({
   breaks: true,
-  gfm: true
+  gfm: true,
+  /**
+   * Inline extension to support {:target="_blank"} attribute syntax on links.
+   * Allows form designers to force any link to open in a new tab, e.g.
+   * [Open the service](https://example.gov.uk){:target="_blank"}
+   */
+  extensions: [{
+    name: 'linkAttributes',
+    level: 'inline',
+    start(src) {
+      return src.indexOf('{:');
+    },
+    tokenizer(src, tokens) {
+      // Quotes are HTML-escaped before parsing, so " becomes "
+      const match = /^\{:target="_blank"\}/.exec(src);
+      if (match && tokens.length > 0) {
+        const last = tokens[tokens.length - 1];
+        if (last.type === 'link') {
+          ;
+          last.forceNewTab = true;
+          return {
+            type: 'linkAttributes',
+            raw: match[0]
+          };
+        }
+      }
+    },
+    renderer() {
+      return '';
+    }
+  }]
 });
-function renderLink(href, text, baseUrl) {
+function renderLink(href, text, baseUrl, forceNewTab = false) {
   let isLocalLink = true;
   if (baseUrl) {
     isLocalLink = href.startsWith(baseUrl) || href.startsWith('mailto:');
   }
+  const openInNewTab = !isLocalLink || forceNewTab;
   const attrs = [`class="govuk-link"`, `href="${href}"`];
-  if (!isLocalLink) {
+  if (openInNewTab) {
     attrs.push(`target="_blank" rel="noreferrer noopener"`);
   }
-  const label = !isLocalLink ? `${text} (opens in new tab)` : text;
+  const label = openInNewTab ? `${text} (opens in new tab)` : text;
   return `<a ${attrs.join(' ')}>${label}</a>`;
 }
 function demoteHeading(text, depth, startingHeaderLevel) {
@@ -35,11 +66,8 @@ export function markdownToHtml(markdown, options) {
   }
   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, options?.baseUrl);
+  renderer.link = token => {
+    return renderLink(token.href, token.text, options?.baseUrl, token.forceNewTab);
   };
   if (options?.startingHeaderLevel) {
     renderer.heading = ({

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

@@ -1 +1 @@
-{"version":3,"file":"markdown.js","names":["Marked","Renderer","marked","breaks","gfm","renderLink","href","text","baseUrl","isLocalLink","startsWith","attrs","push","label","join","demoteHeading","depth","startingHeaderLevel","Math","min","markdownToHtml","markdown","options","undefined","escaped","replace","renderer","link","heading","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\nfunction demoteHeading(\n  text: string,\n  depth: number,\n  startingHeaderLevel: number\n) {\n  // Max heading is h6 so don't demote further than that\n  depth = Math.min(depth + startingHeaderLevel - 1, 6)\n  return `<h${depth}>${text}</h${depth}>\n`\n}\n\n/**\n * Convert markdown to HTML, escaping any HTML tags first\n */\nexport function markdownToHtml(\n  markdown: string | null | undefined,\n  options?: {\n    baseUrl?: string // optional in some contexts, e.g. from the designer where it might not make sense,\n    startingHeaderLevel?: number\n  }\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, options?.baseUrl)\n  }\n  if (options?.startingHeaderLevel) {\n    renderer.heading = ({ text, depth }: Tokens.Heading): string => {\n      return demoteHeading(text, depth, options.startingHeaderLevel ?? 1)\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,SAASE,aAAaA,CACpBR,IAAY,EACZS,KAAa,EACbC,mBAA2B,EAC3B;EACA;EACAD,KAAK,GAAGE,IAAI,CAACC,GAAG,CAACH,KAAK,GAAGC,mBAAmB,GAAG,CAAC,EAAE,CAAC,CAAC;EACpD,OAAO,KAAKD,KAAK,IAAIT,IAAI,MAAMS,KAAK;AACtC,CAAC;AACD;;AAEA;AACA;AACA;AACA,OAAO,SAASI,cAAcA,CAC5BC,QAAmC,EACnCC,OAGC,EACD;EACA,IAAID,QAAQ,KAAKE,SAAS,IAAIF,QAAQ,KAAK,IAAI,EAAE;IAC/C,OAAO,EAAE;EACX;EAEA,MAAMG,OAAO,GAAGH,QAAQ,CACrBI,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,IAAIzB,QAAQ,CAAC,CAAC;EAC/ByB,QAAQ,CAACC,IAAI,GAAG,CAAC;IAAErB,IAAI;IAAEC;EAAkB,CAAC,KAAa;IACvD,OAAOF,UAAU,CAACC,IAAI,EAAEC,IAAI,EAAEe,OAAO,EAAEd,OAAO,CAAC;EACjD,CAAC;EACD,IAAIc,OAAO,EAAEL,mBAAmB,EAAE;IAChCS,QAAQ,CAACE,OAAO,GAAG,CAAC;MAAErB,IAAI;MAAES;IAAsB,CAAC,KAAa;MAC9D,OAAOD,aAAa,CAACR,IAAI,EAAES,KAAK,EAAEM,OAAO,CAACL,mBAAmB,IAAI,CAAC,CAAC;IACrE,CAAC;EACH;EACA,OAAOf,MAAM,CAAC2B,KAAK,CAACL,OAAO,EAAE;IAAEM,KAAK,EAAE,KAAK;IAAEJ;EAAS,CAAC,CAAC;AAC1D","ignoreList":[]}
+{"version":3,"file":"markdown.js","names":["Marked","Renderer","marked","breaks","gfm","extensions","name","level","start","src","indexOf","tokenizer","tokens","match","exec","length","last","type","forceNewTab","raw","renderer","renderLink","href","text","baseUrl","isLocalLink","startsWith","openInNewTab","attrs","push","label","join","demoteHeading","depth","startingHeaderLevel","Math","min","markdownToHtml","markdown","options","undefined","escaped","replace","link","token","heading","parse","async"],"sources":["../../../src/utils/markdown.ts"],"sourcesContent":["import { Marked, Renderer, type Token, 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  /**\n   * Inline extension to support {:target=\"_blank\"} attribute syntax on links.\n   * Allows form designers to force any link to open in a new tab, e.g.\n   * [Open the service](https://example.gov.uk){:target=\"_blank\"}\n   */\n  extensions: [\n    {\n      name: 'linkAttributes',\n      level: 'inline',\n      start(src: string) {\n        return src.indexOf('{:')\n      },\n      tokenizer(src: string, tokens: Token[]) {\n        // Quotes are HTML-escaped before parsing, so \" becomes &quot;\n        const match = /^\\{:target=&quot;_blank&quot;\\}/.exec(src)\n        if (match && tokens.length > 0) {\n          const last = tokens[tokens.length - 1]\n          if (last.type === 'link') {\n            ;(last as Tokens.Link & { forceNewTab: boolean }).forceNewTab = true\n            return {\n              type: 'linkAttributes',\n              raw: match[0]\n            }\n          }\n        }\n      },\n      renderer() {\n        return ''\n      }\n    }\n  ]\n})\n\nfunction renderLink(\n  href: string,\n  text: string,\n  baseUrl?: string,\n  forceNewTab = false\n) {\n  let isLocalLink = true\n\n  if (baseUrl) {\n    isLocalLink = href.startsWith(baseUrl) || href.startsWith('mailto:')\n  }\n\n  const openInNewTab = !isLocalLink || forceNewTab\n\n  const attrs = [`class=\"govuk-link\"`, `href=\"${href}\"`]\n\n  if (openInNewTab) {\n    attrs.push(`target=\"_blank\" rel=\"noreferrer noopener\"`)\n  }\n\n  const label = openInNewTab ? `${text} (opens in new tab)` : text\n\n  return `<a ${attrs.join(' ')}>${label}</a>`\n}\n\nfunction demoteHeading(\n  text: string,\n  depth: number,\n  startingHeaderLevel: number\n) {\n  // Max heading is h6 so don't demote further than that\n  depth = Math.min(depth + startingHeaderLevel - 1, 6)\n  return `<h${depth}>${text}</h${depth}>\n`\n}\n\n/**\n * Convert markdown to HTML, escaping any HTML tags first\n */\nexport function markdownToHtml(\n  markdown: string | null | undefined,\n  options?: {\n    baseUrl?: string // optional in some contexts, e.g. from the designer where it might not make sense,\n    startingHeaderLevel?: number\n  }\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 = (token: Tokens.Link): string => {\n    return renderLink(\n      token.href,\n      token.text,\n      options?.baseUrl,\n      (token as Tokens.Link & { forceNewTab?: boolean }).forceNewTab\n    )\n  }\n  if (options?.startingHeaderLevel) {\n    renderer.heading = ({ text, depth }: Tokens.Heading): string => {\n      return demoteHeading(text, depth, options.startingHeaderLevel ?? 1)\n    }\n  }\n  return marked.parse(escaped, { async: false, renderer })\n}\n"],"mappings":"AAAA,SAASA,MAAM,EAAEC,QAAQ,QAAiC,QAAQ;;AAElE;AACA;AACA;AACA,OAAO,MAAMC,MAAM,GAAG,IAAIF,MAAM,CAAC;EAC/BG,MAAM,EAAE,IAAI;EACZC,GAAG,EAAE,IAAI;EAET;AACF;AACA;AACA;AACA;EACEC,UAAU,EAAE,CACV;IACEC,IAAI,EAAE,gBAAgB;IACtBC,KAAK,EAAE,QAAQ;IACfC,KAAKA,CAACC,GAAW,EAAE;MACjB,OAAOA,GAAG,CAACC,OAAO,CAAC,IAAI,CAAC;IAC1B,CAAC;IACDC,SAASA,CAACF,GAAW,EAAEG,MAAe,EAAE;MACtC;MACA,MAAMC,KAAK,GAAG,iCAAiC,CAACC,IAAI,CAACL,GAAG,CAAC;MACzD,IAAII,KAAK,IAAID,MAAM,CAACG,MAAM,GAAG,CAAC,EAAE;QAC9B,MAAMC,IAAI,GAAGJ,MAAM,CAACA,MAAM,CAACG,MAAM,GAAG,CAAC,CAAC;QACtC,IAAIC,IAAI,CAACC,IAAI,KAAK,MAAM,EAAE;UACxB;UAAED,IAAI,CAA4CE,WAAW,GAAG,IAAI;UACpE,OAAO;YACLD,IAAI,EAAE,gBAAgB;YACtBE,GAAG,EAAEN,KAAK,CAAC,CAAC;UACd,CAAC;QACH;MACF;IACF,CAAC;IACDO,QAAQA,CAAA,EAAG;MACT,OAAO,EAAE;IACX;EACF,CAAC;AAEL,CAAC,CAAC;AAEF,SAASC,UAAUA,CACjBC,IAAY,EACZC,IAAY,EACZC,OAAgB,EAChBN,WAAW,GAAG,KAAK,EACnB;EACA,IAAIO,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,YAAY,GAAG,CAACF,WAAW,IAAIP,WAAW;EAEhD,MAAMU,KAAK,GAAG,CAAC,oBAAoB,EAAE,SAASN,IAAI,GAAG,CAAC;EAEtD,IAAIK,YAAY,EAAE;IAChBC,KAAK,CAACC,IAAI,CAAC,2CAA2C,CAAC;EACzD;EAEA,MAAMC,KAAK,GAAGH,YAAY,GAAG,GAAGJ,IAAI,qBAAqB,GAAGA,IAAI;EAEhE,OAAO,MAAMK,KAAK,CAACG,IAAI,CAAC,GAAG,CAAC,IAAID,KAAK,MAAM;AAC7C;AAEA,SAASE,aAAaA,CACpBT,IAAY,EACZU,KAAa,EACbC,mBAA2B,EAC3B;EACA;EACAD,KAAK,GAAGE,IAAI,CAACC,GAAG,CAACH,KAAK,GAAGC,mBAAmB,GAAG,CAAC,EAAE,CAAC,CAAC;EACpD,OAAO,KAAKD,KAAK,IAAIV,IAAI,MAAMU,KAAK;AACtC,CAAC;AACD;;AAEA;AACA;AACA;AACA,OAAO,SAASI,cAAcA,CAC5BC,QAAmC,EACnCC,OAGC,EACD;EACA,IAAID,QAAQ,KAAKE,SAAS,IAAIF,QAAQ,KAAK,IAAI,EAAE;IAC/C,OAAO,EAAE;EACX;EAEA,MAAMG,OAAO,GAAGH,QAAQ,CACrBI,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,MAAMtB,QAAQ,GAAG,IAAInB,QAAQ,CAAC,CAAC;EAC/BmB,QAAQ,CAACuB,IAAI,GAAIC,KAAkB,IAAa;IAC9C,OAAOvB,UAAU,CACfuB,KAAK,CAACtB,IAAI,EACVsB,KAAK,CAACrB,IAAI,EACVgB,OAAO,EAAEf,OAAO,EACfoB,KAAK,CAA6C1B,WACrD,CAAC;EACH,CAAC;EACD,IAAIqB,OAAO,EAAEL,mBAAmB,EAAE;IAChCd,QAAQ,CAACyB,OAAO,GAAG,CAAC;MAAEtB,IAAI;MAAEU;IAAsB,CAAC,KAAa;MAC9D,OAAOD,aAAa,CAACT,IAAI,EAAEU,KAAK,EAAEM,OAAO,CAACL,mBAAmB,IAAI,CAAC,CAAC;IACrE,CAAC;EACH;EACA,OAAOhC,MAAM,CAAC4C,KAAK,CAACL,OAAO,EAAE;IAAEM,KAAK,EAAE,KAAK;IAAE3B;EAAS,CAAC,CAAC;AAC1D","ignoreList":[]}

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,EAAyB,MAAM,QAAQ,CAAA;AAEtD;;GAEG;AACH,eAAO,MAAM,MAAM,QAGjB,CAAA;AA+BF;;GAEG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE;IACR,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAC7B,UAuBF"}
+{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../../../src/utils/markdown.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAqC,MAAM,QAAQ,CAAA;AAElE;;GAEG;AACH,eAAO,MAAM,MAAM,QAmCjB,CAAA;AAsCF;;GAEG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EACnC,OAAO,CAAC,EAAE;IACR,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAC7B,UA4BF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@defra/forms-model",
-  "version": "3.0.636",
+  "version": "3.0.637",
   "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,27 +1,66 @@
-import { Marked, Renderer, type Tokens } from 'marked'
+import { Marked, Renderer, type Token, type Tokens } from 'marked'
 
 /**
  * Marked instance (avoids global option/extension scope)
  */
 export const marked = new Marked({
   breaks: true,
-  gfm: true
+  gfm: true,
+
+  /**
+   * Inline extension to support {:target="_blank"} attribute syntax on links.
+   * Allows form designers to force any link to open in a new tab, e.g.
+   * [Open the service](https://example.gov.uk){:target="_blank"}
+   */
+  extensions: [
+    {
+      name: 'linkAttributes',
+      level: 'inline',
+      start(src: string) {
+        return src.indexOf('{:')
+      },
+      tokenizer(src: string, tokens: Token[]) {
+        // Quotes are HTML-escaped before parsing, so " becomes "
+        const match = /^\{:target="_blank"\}/.exec(src)
+        if (match && tokens.length > 0) {
+          const last = tokens[tokens.length - 1]
+          if (last.type === 'link') {
+            ;(last as Tokens.Link & { forceNewTab: boolean }).forceNewTab = true
+            return {
+              type: 'linkAttributes',
+              raw: match[0]
+            }
+          }
+        }
+      },
+      renderer() {
+        return ''
+      }
+    }
+  ]
 })
 
-function renderLink(href: string, text: string, baseUrl?: string) {
+function renderLink(
+  href: string,
+  text: string,
+  baseUrl?: string,
+  forceNewTab = false
+) {
   let isLocalLink = true
 
   if (baseUrl) {
     isLocalLink = href.startsWith(baseUrl) || href.startsWith('mailto:')
   }
 
+  const openInNewTab = !isLocalLink || forceNewTab
+
   const attrs = [`class="govuk-link"`, `href="${href}"`]
 
-  if (!isLocalLink) {
+  if (openInNewTab) {
     attrs.push(`target="_blank" rel="noreferrer noopener"`)
   }
 
-  const label = !isLocalLink ? `${text} (opens in new tab)` : text
+  const label = openInNewTab ? `${text} (opens in new tab)` : text
 
   return `<a ${attrs.join(' ')}>${label}</a>`
 }
@@ -59,8 +98,13 @@ export function markdownToHtml(
     .replace(/'/g, '&#39;')
 
   const renderer = new Renderer()
-  renderer.link = ({ href, text }: Tokens.Link): string => {
-    return renderLink(href, text, options?.baseUrl)
+  renderer.link = (token: Tokens.Link): string => {
+    return renderLink(
+      token.href,
+      token.text,
+      options?.baseUrl,
+      (token as Tokens.Link & { forceNewTab?: boolean }).forceNewTab
+    )
   }
   if (options?.startingHeaderLevel) {
     renderer.heading = ({ text, depth }: Tokens.Heading): string => {