npm - @bartificer/linkify - Versions diffs - 2.3.2 → 2.3.4 - Mend

@bartificer/linkify 2.3.2 → 2.3.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (63) hide show

package/dist/index.js +1 -1
package/docs/LinkData.class.mjs.html +150 -0
package/docs/LinkTemplate.class.mjs.html +141 -0
package/docs/Linkifier.class.mjs.html +411 -0
package/docs/PageData.class.mjs.html +272 -0
package/docs/data/search.json +1 -0
package/docs/defaults.mjs.html +101 -0
package/docs/externals.jsdoc.html +37 -0
package/docs/fonts/Inconsolata-Regular.ttf +0 -0
package/docs/fonts/OpenSans-Regular.ttf +0 -0
package/docs/fonts/WorkSans-Bold.ttf +0 -0
package/docs/index.html +28 -0
package/docs/index.js.html +49 -0
package/docs/module-LinkData.LinkData.html +13 -0
package/docs/module-LinkData.html +3 -0
package/docs/module-LinkTemplate.LinkTemplate.html +3 -0
package/docs/module-LinkTemplate.html +3 -0
package/docs/module-Linkifier.Linkifier.html +3 -0
package/docs/module-Linkifier.html +3 -0
package/docs/module-PageData.PageData.html +15 -0
package/docs/module-PageData.html +3 -0
package/docs/module-cheerio.html +3 -0
package/docs/module-defaults.html +3 -0
package/docs/module-linkify.html +3 -0
package/docs/module-mustache.html +3 -0
package/docs/module-node-fetch.html +3 -0
package/docs/module-title-case.html +3 -0
package/docs/module-urijs.html +3 -0
package/docs/module-url-slug.html +3 -0
package/docs/module-utilities.html +3 -0
package/docs/scripts/core.js +726 -0
package/docs/scripts/core.min.js +23 -0
package/docs/scripts/resize.js +90 -0
package/docs/scripts/search.js +265 -0
package/docs/scripts/search.min.js +6 -0
package/docs/scripts/third-party/Apache-License-2.0.txt +202 -0
package/docs/scripts/third-party/fuse.js +9 -0
package/docs/scripts/third-party/hljs-line-num-original.js +369 -0
package/docs/scripts/third-party/hljs-line-num.js +1 -0
package/docs/scripts/third-party/hljs-original.js +5171 -0
package/docs/scripts/third-party/hljs.js +1 -0
package/docs/scripts/third-party/popper.js +5 -0
package/docs/scripts/third-party/tippy.js +1 -0
package/docs/scripts/third-party/tocbot.js +672 -0
package/docs/scripts/third-party/tocbot.min.js +1 -0
package/docs/styles/clean-jsdoc-theme-base.css +1159 -0
package/docs/styles/clean-jsdoc-theme-dark.css +412 -0
package/docs/styles/clean-jsdoc-theme-light.css +482 -0
package/docs/styles/clean-jsdoc-theme-scrollbar.css +30 -0
package/docs/styles/clean-jsdoc-theme-without-scrollbar.min.css +1 -0
package/docs/styles/clean-jsdoc-theme.min.css +1 -0
package/docs/utilities.mjs.html +151 -0
package/examples/clipboardURLToMarkdown.mjs +74 -0
package/examples/debugClipboardURL.mjs +7 -0
package/package.json +8 -3
package/src/LinkData.class.mjs +13 -0
package/src/LinkTemplate.class.mjs +14 -0
package/src/Linkifier.class.mjs +22 -2
package/src/PageData.class.mjs +13 -0
package/src/defaults.mjs +11 -0
package/src/externals.jsdoc +35 -0
package/src/index.js +40 -5
package/src/utilities.mjs +21 -7

package/docs/Linkifier.class.mjs.html ADDED Viewed

@@ -0,0 +1,411 @@
+<!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Source: Linkifier.class.mjs</title><!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124    C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124    c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227    c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6    V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474    c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323    c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848    S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328    c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="fallback-light"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">Bartificer Linkifier</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-LinkData.html">LinkData</a></div><div class="sidebar-section-children"><a href="module-LinkTemplate.html">LinkTemplate</a></div><div class="sidebar-section-children"><a href="module-Linkifier.html">Linkifier</a></div><div class="sidebar-section-children"><a href="module-PageData.html">PageData</a></div><div class="sidebar-section-children"><a href="module-defaults.html">defaults</a></div><div class="sidebar-section-children"><a href="module-linkify.html">linkify</a></div><div class="sidebar-section-children"><a href="module-utilities.html">utilities</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-LinkData.LinkData.html">LinkData</a></div><div class="sidebar-section-children"><a href="module-LinkTemplate.LinkTemplate.html">LinkTemplate</a></div><div class="sidebar-section-children"><a href="module-Linkifier.Linkifier.html">Linkifier</a></div><div class="sidebar-section-children"><a href="module-PageData.PageData.html">PageData</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-externals"><div>Externals</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-cheerio.html">cheerio</a></div><div class="sidebar-section-children"><a href="module-mustache.html">mustache</a></div><div class="sidebar-section-children"><a href="module-node-fetch.html">node-fetch</a></div><div class="sidebar-section-children"><a href="module-title-case.html">title-case</a></div><div class="sidebar-section-children"><a href="module-urijs.html">urijs</a></div><div class="sidebar-section-children"><a href="module-url-slug.html">url-slug</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section id="source-page" class="source-page"><header><h1 id="title" class="has-anchor">Linkifier.class.mjs</h1></header><article><pre class="prettyprint source lang-js"><code>/**
+ * @file The definition of the main Linkifier class which provides the link rendering functionality with the help of the other classes and modules.
+ * @author Bart Busschots &lt;opensource@bartificer.ie>
+ */
+/**
+ * Linkifier's core link rendering functionality.
+ * @module Linkifier
+ * @requires LinkData
+ * @requires LinkTemplate
+ * @requires PageData
+ * @requires module:node-fetch
+ * @requires module:cheerio
+ * @requires module:mustache
+ */
+import { PageData } from './PageData.class.mjs';
+import { LinkData } from './LinkData.class.mjs';
+import { LinkTemplate } from './LinkTemplate.class.mjs';
+import * as utilities from "./utilities.mjs";
+import * as defaults from "./defaults.mjs";
+import fetch from 'node-fetch';
+import * as cheerio from 'cheerio';
+import Mustache from 'mustache';
+/**
+ * The class providing the link rendering functionality. Instances of this class capture the settings for generating links, and, generate links using these settings.
+ */
+export class Linkifier {
+    constructor(){
+        /**
+         * A mapping of domain names to data transformation functions.
+         *
+         * @private
+         * @type {Object.&lt;FQDN, dataTransformer>}
+         */
+        this._pageDataToLinkDataTransmformers = {
+            '.' : function(pData){
+                let text = pData.title;
+                if(pData.h1s.length === 1){
+                    text = pData.mainHeading;
+                }
+                return new LinkData(pData.url, text);
+            }
+        };
+        /**
+         * A mapping of domains names to default template names.
+         *
+         * @private
+         * @type {Object.&lt;FQDN, templateName>}
+         */
+        this._pageDataToLinkTemplateName = {
+            '.' : 'html' // default to the 'html' template for all domains unless otherwise specified
+        };
+        /**
+         * The registered link templates.
+         *
+         * @private
+         * @type {Object.&lt;templateName, module:@bartificer/linkify.LinkTemplate>}
+         */
+        this._linkTemplates = {};
+        /**
+         * The loaded list of words with customised capitalisations.
+         *
+         * @private
+         * @type {string[]}
+         */
+        this._speciallyCapitalisedWords = [];
+        defaults.speciallyCapitalisedWords.map(word => this._speciallyCapitalisedWords.push(word));
+        /**
+         * A collection of utility functions.
+         *
+         * @private
+         * @type {Object.&lt;string, Function>}
+         */
+        this._utilities = utilities;
+        //
+        // -- Create and register the default templates --
+        //
+        for (const [name, template] of Object.entries(defaults.linkTemplates)) {
+            this.registerTemplate(name, template);
+        }
+    }
+    /**
+     * @type {Object.&lt;string, Function>}
+     */
+    get utilities() {
+        return this._utilities;
+    }
+    /**
+     * @see Linfifier.utilities
+     */
+    get util(){
+        return this._utilities;
+    }
+    /**
+     * @returns {string[]} The current list of known words with special capitalisations.
+     */
+    get speciallyCapitalisedWords(){
+        const ans = [];
+        this._speciallyCapitalisedWords.map(word => ans.push(word));
+        return ans;
+    }
+    /**
+     * @param {string[]} words - a list of words with special capitalisations
+     */
+    set speciallyCapitalisedWords(words){
+        // TO DO - add validation
+        this._speciallyCapitalisedWords = words;
+    }
+    /**
+     * Register a data transformer function for a given domain.
+     *
+     * @param {domainName} domain - The domain for which this transformer should be
+     * used.
+     * @param {dataTransformer} transformerFn - The data transformer callback.
+     * @throws {ValidationError} A validation error is thrown if either parameter
+     * is missing or invalid.
+     */
+    registerTransformer(domain, transformerFn){
+        // TO DO - add validation
+        let fqdn = String(domain);
+        if(!fqdn.match(/[.]$/)){
+            fqdn += '.';
+        }
+        this._pageDataToLinkDataTransmformers[fqdn] = transformerFn;
+    }
+    /**
+     * Get the data transformer function for a given domain.
+     *
+     * Note that domains are searched from the subdomain up. For example, if passed
+     * the domain `www.bartificer.net` the function will first look for a
+     * transformer for the domain `www.bartificer.net`, if there's no transformer
+     * registered for that domain it will look for a transformer for the domain
+     * `bartificer.net`, if there's no transformer for that domain either it will
+     * return the default transformer.
+     *
+     * @param {domainName} domain - The domain to get the data transformer for.
+     * @returns {dataTransformer}
+     * @throws {ValidationError} A validation error is thrown unless a valid domain
+     * name is passed.
+     */
+    getTransformerForDomain(domain){
+        // TO DO - add validation
+        let fqdn = String(domain);
+        if(!fqdn.match(/[.]$/)){
+            fqdn += '.';
+        }
+        // return the most exact match
+        while(fqdn.match(/[.][^.]+[.]$/)){
+            if(this._pageDataToLinkDataTransmformers[fqdn]){
+                //console.log(`returning transformer for '${fqdn}'`);
+                return this._pageDataToLinkDataTransmformers[fqdn];
+            }
+            //console.log(`no transformer found for '${fqdn}'`);
+            fqdn = fqdn.replace(/^[^.]+[.]/, '');
+        }
+        //console.log('returning default transformer');
+        return this._pageDataToLinkDataTransmformers['.'];
+    }
+    /**
+     * A list of the names of the registered link templates.
+     * @type {string[]}
+     */
+    get templateNames() {
+        return Object.keys(this._linkTemplates);
+    }
+    /**
+     * @returns {string} The name of the default template.
+     */
+    get defaultTemplateName(){
+        return this._pageDataToLinkTemplateName['.'];
+    }
+    /**
+     * @param {string} templateName - The name of the default template to use.
+     * @throws {ValidationError} A validation error is thrown if the template name is missing, invalid, or doesn't correspond to a registered template.
+     */
+    set defaultTemplateName(templateName){
+        const tplName = String(templateName);
+        if(!this._linkTemplates[tplName]){
+            throw new ValidationError(`No template named '${tplName}' is registered`);
+        }
+        this._pageDataToLinkTemplateName['.'] = tplName;
+    }
+    /**
+     * The default link template.
+     * @type {LinkTemplate}
+     */
+    get defaultTemplate(){
+        return this._linkTemplates[this._pageDataToLinkTemplateName['.']];
+    }
+    /**
+     * Register a link template.
+     *
+     * @param {templateName} name
+     * @param {module:@bartificer/linkify.LinkTemplate} template
+     * @throws {ValidationError} A validation error is thrown unless both a valid
+     * name and template object are passed.
+     */
+    registerTemplate(name, template){
+        // TO DO - add validation
+        const tplName = String(name);
+        this._linkTemplates[tplName] = template;
+    }
+    /**
+     * Get a registered link template by name.
+     *
+     * @param {string} templateName
+     * @returns {LinkTemplate}
+     * @throws {ValidationError} A validation error is thrown unless a valid name is passed and corresponds to a registered template.
+     */
+    getTemplate(templateName){
+        const tplName = String(templateName);
+        if(!this._linkTemplates[tplName]){
+            throw new ValidationError(`No template named '${tplName}' is registered`);
+        }
+        return this._linkTemplates[tplName];
+    }
+    /**
+     * Register a default template for use with a given domain. This template will
+     * override the overall default for this domain and all its subdomains.
+     *
+     * @param {domainName} domain - The domain for which this template should be used by default.
+     * @param {templateName} templateName - The name of the template to use.
+     * @throws {ValidationError} A validation error is thrown if either parameter
+     * is missing or invalid.
+     */
+    registerDefaultTemplateMapping(domain, templateName){
+        // TO DO - add validation
+        let fqdn = String(domain);
+        if(!fqdn.match(/[.]$/)){
+            fqdn += '.';
+        }
+        this._pageDataToLinkTemplateName[fqdn] = templateName;
+    }
+    /**
+     * Get the data transformer function for a given domain.
+     *
+     * Note that domains are searched from the subdomain up. For example, if passed
+     * the domain `www.bartificer.net` the function will first look for a
+     * transformer for the domain `www.bartificer.net`, if there's no transformer
+     * registered for that domain it will look for a transformer for the domain
+     * `bartificer.net`, if there's no transformer for that domain either it will
+     * return the default transformer.
+     *
+     * @param {domainName} domain - The domain to get the data transformer for.
+     * @returns {dataTransformer}
+     * @throws {ValidationError} A validation error is thrown unless a valid domain
+     * name is passed.
+     */
+    getTemplateNameForDomain(domain){
+        // TO DO - add validation
+        let fqdn = String(domain);
+        if(!fqdn.match(/[.]$/)){
+            fqdn += '.';
+        }
+        // return the most exact match
+        while(fqdn.match(/[.][^.]+[.]$/)){
+            if(this._pageDataToLinkTemplateName[fqdn]){
+                let tplName = this._pageDataToLinkTemplateName[fqdn];
+                // make sure the template exists
+                if(!this._linkTemplates[tplName]){
+                    console.warn(`No template named '${tplName}' is registered, falling back to global default '${this._pageDataToLinkTemplateName['.']}'`);
+                    return this._pageDataToLinkTemplateName['.'];
+                }
+                //console.log(`returning template name for '${fqdn}'`);
+                return this._pageDataToLinkTemplateName[fqdn];
+            }
+            //console.log(`no template name found for '${fqdn}'`);
+            fqdn = fqdn.replace(/^[^.]+[.]/, '');
+        }
+        //console.log('returning default template name');
+        return this._pageDataToLinkTemplateName['.'];
+    }
+    /**
+     * Fetch the page data for a given URL.
+     *
+     * @async
+     * @param {URL} url
+     * @returns {PageData}
+     * @throws {ValidationError} A validation error is thrown unless a valid URL is
+     * passed.
+     */
+    async fetchPageData(url){
+        // TO DO - add validation
+        let ans = new PageData(url);
+        // then try load the contents form the web
+        let webDownloadResponseBody = '';
+        try {
+            let webDownloadResponse = await fetch(url);
+            if(!webDownloadResponse.ok){
+                throw new Error(`HTTP ${webDownloadResponse.status}: ${webDownloadResponse.statusText}`);
+            }
+            webDownloadResponseBody = await webDownloadResponse.text();
+        } catch (err) {
+            // fall back to extracting the title from the URL slug
+            console.warn(`Falling back to de-slugifying URL (${err.message})`);
+            ans.title = this.utilities.extractSlug(url, this._speciallyCapitalisedWords) || 'Untitled';
+            return ans;
+        }
+        let $ = cheerio.load(webDownloadResponseBody);
+        ans.title = $('title').text().trim();
+        $('h1').each(function(){
+            ans.h1($(this).text().trim());
+        });
+        $('h2').each(function(){
+            ans.h2($(this).text().trim());
+        });
+        // return the answer
+        return ans;
+    }
+    /**
+     * Generate a link given a URL. By default the registered template for the
+     * URL's domain will be used, or, if none is registered, the overall
+     * default will be used (`html`).
+     *
+     * @async
+     * @param {URL} url
+     * @param {templateName} [templateName='html']
+     * @returns {string}
+     * @throws {ValidationError} A validation error is thrown unless a valid URL is
+     * passed.
+     */
+    async generateLink(url, templateName){
+        // TO DO - add validation
+        //
+        // -- resolve the template name to use for this URL --
+        //
+        let tplName = '';
+        // resolve the template — if a template name is passed, try use it,
+        // otherwise resolve the default for this URL's domain
+        if(templateName &amp;&amp; typeof templateName === 'string'){
+            tplName = templateName;
+            // make sure the template exists
+            if(!this._linkTemplates[tplName]){
+                console.warn(`No template named '${tplName}' is registered, falling back to global default '${this._pageDataToLinkTemplateName['.']}'`);
+                tplName = this._pageDataToLinkTemplateName['.'];
+            }
+        } else {
+            tplName = this.getTemplateNameForDomain((new URL(url)).hostname);
+        }
+        const template = this._linkTemplates[tplName];
+        // get the page data
+        const pageData = await this.fetchPageData(url);
+        // transform the page data to link data
+        const linkData = this.getTransformerForDomain(pageData.uri.hostname())(pageData);
+        // apply field-specific filters to the link data
+        const fieldNames = ['url', 'text', 'description'];
+        const templateData = linkData.asPlainObject();
+        for(let fieldName of fieldNames){
+            let fieldFilters = template.filtersFor(fieldName);
+            for(let filterFn of fieldFilters){
+                templateData[fieldName] = filterFn(templateData[fieldName]);
+            }
+        }
+        // apply the universal filters to all the link data fields
+        let globalFilters = template.filtersFor('all');
+        for(let filterFn of globalFilters){
+            for(let fieldName of fieldNames){
+                templateData[fieldName] = filterFn(templateData[fieldName]);
+            }
+        }
+        // render the link
+        return Mustache.render(this._linkTemplates[tplName].templateString, templateData);
+    }
+};</code></pre></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">Bartificer Linkifier</a><div class="mobile-nav-links"></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-LinkData.html">LinkData</a></div><div class="sidebar-section-children"><a href="module-LinkTemplate.html">LinkTemplate</a></div><div class="sidebar-section-children"><a href="module-Linkifier.html">Linkifier</a></div><div class="sidebar-section-children"><a href="module-PageData.html">PageData</a></div><div class="sidebar-section-children"><a href="module-defaults.html">defaults</a></div><div class="sidebar-section-children"><a href="module-linkify.html">linkify</a></div><div class="sidebar-section-children"><a href="module-utilities.html">utilities</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-LinkData.LinkData.html">LinkData</a></div><div class="sidebar-section-children"><a href="module-LinkTemplate.LinkTemplate.html">LinkTemplate</a></div><div class="sidebar-section-children"><a href="module-Linkifier.Linkifier.html">Linkifier</a></div><div class="sidebar-section-children"><a href="module-PageData.PageData.html">PageData</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-externals"><div>Externals</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-cheerio.html">cheerio</a></div><div class="sidebar-section-children"><a href="module-mustache.html">mustache</a></div><div class="sidebar-section-children"><a href="module-node-fetch.html">node-fetch</a></div><div class="sidebar-section-children"><a href="module-title-case.html">title-case</a></div><div class="sidebar-section-children"><a href="module-urijs.html">urijs</a></div><div class="sidebar-section-children"><a href="module-url-slug.html">url-slug</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>