update docs (0.17.0)

Author: pragmar

readme.md README.mdreadme.md renamed to README.md

@@ -10,11 +10,11 @@
    <a href="https://interro.bot/">InterroBot</a>
 <p>
 
-Your web crawler just got superpowers. InterroBot plugins transform your web crawler into a customizable data powerhouse, unleashing unlimited potential for data extraction and analysis.
+InterroBot plugins transform your web crawler into, well... anything you want. With unrestricted API crawl data access, Interrobot plugins can bring your website analysis concepts to life.
 
-InterroBot plugins are simple HTML/JS/CSS pages that transform raw web crawl data into profound insights, stunning visualizations, and interactive dashboards. With our flexible API, you can create custom plugins that analyze website content across entire domains, connecting with analytics, LLMs, or your favorite SaaS for deeper insights.
+InterroBot plugins are simple HTML/JS/CSS pages that turn crawl data into insights, stunning visualizations, and interactive dashboards. With our flexible API, you can create custom plugins that analyze website content across entire domains, connecting with analytics, LLMs, or your favorite SaaS for deeper insights.
 
-Our plugin ecosystem is designed for versatility. Whether you're building proprietary tools, developing plugins for clients, or contributing to the open-source community, InterroBot plugins adapt to your needs. Available for Windows 10/11, macOS, and Android, our platform ensures your data analysis can happen wherever you work.
+The InterroBot plugin ecosystem is designed for power users. Whether you're building proprietary tools, developing plugins for clients, or contributing to the open-source community, InterroBot plugins adapt to your needs. Available for Windows 10/11, macOS, Linux, and Android, InterroBot plugins are everywhere you need them.
 
 ## How Does it Work?
 
@@ -108,7 +108,7 @@ The above snippets are pulled (and gently modified) from a plugin in the reposit
 
 ## What data is available via API?
 
-InterroBot's robust API provides plugin developers with access to crawled data, enabling deep analysis and useful customizations. This data forms the foundation of your plugin, allowing you to create insightful visualizations, perform complex analysis, or build interactive tools. Whether you're tracking SEO metrics, analyzing content structures, or developing custom reporting tools, our API offers the flexibility and depth you need. Below is an overview of the key data points available, organized by API endpoint:
+InterroBot's API provides developers with access to crawled data, enabling analysis and useful customizations. This data allows you to create insightful visualizations, perform complex analysis, or build interactive tools. Whether you're tracking SEO metrics, analyzing content structures, or developing custom reporting tools, our API offers the flexibility and depth you need. Below is an overview of the key data points available, organized by API endpoint:
 
 ### GetProjects
 

dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "interrobot-plugin",
-    "version": "0.16.0",
+    "version": "0.17.0",
     "description": "Used in the creation of plugins (aka reports) that present data or visualizations for a website in aggregate, across site content. For use with InterroBot application.",
     "main": "js/commonjs/interrobot-plugin.js",
     "module": "js/es6/interrobot-plugin.js",

docs-rtd/source/index.rst

@@ -20,21 +20,21 @@
 interrobot-plugin
 =============================================
 
-Your web crawler just got superpowers. InterroBot plugins transform your
-web crawler into a customizable data powerhouse, unleashing unlimited
-potential for data extraction and analysis.
-
-InterroBot plugins are simple HTML/JS/CSS pages that transform raw web
-crawl data into profound insights, stunning visualizations, and
-interactive dashboards. With our flexible API, you can create custom
-plugins that analyze website content across entire domains, connecting
-with analytics, LLMs, or your favorite SaaS for deeper insights.
-
-Our plugin ecosystem is designed for versatility. Whether you’re
-building proprietary tools, developing plugins for clients, or
-contributing to the open-source community, InterroBot plugins adapt to
-your needs. Available for Windows 10/11, macOS, and Android, our
-platform ensures your data analysis can happen wherever you work.
+InterroBot plugins transform your web crawler into a customizable data
+powerhouse, with the capability to bring your concepts for website analysis
+to life.
+
+InterroBot plugins are simple HTML/JS/CSS pages that turn crawl data into
+insights, stunning visualizations, and interactive dashboards. With our
+flexible API, you can create custom plugins that analyze website content
+across entire domains, connecting with analytics, LLMs, or your favorite
+SaaS for deeper insights.
+
+The InterroBot plugin ecosystem is designed for power users. Whether you're
+building proprietary tools, developing plugins for clients, or contributing
+to the open-source community, InterroBot plugins adapt to your needs.
+Available for Windows 10/11, macOS, Linux, and Android, InterroBot plugins
+are everywhere you need them.
 
 How Does it Work?
 -----------------
@@ -52,7 +52,7 @@ and a script extending the Plugin base class.
 
    // TypeScript vs. JavaScript, both are fine. See examples.
    import { Plugin } from "./src/ts/core/plugin";
-   class BasicExamplePlugin extends Plugin {    
+   class BasicExamplePlugin extends Plugin {
        static meta = {
            "title": "Example Plugin",
            "category": "Example",
@@ -63,7 +63,7 @@ and a script extending the Plugin base class.
        };
        constructor() {
            super();
-           // index() has nothing to do with the crawl index, btw. it is 
+           // index() has nothing to do with the crawl index, btw. it is
            // the plugin index (think index.html), a view that shows by
            // default, and would generally consist of a form or visualization.
            this.index();
@@ -82,10 +82,10 @@ default ``index()`` behavior, rendering your page however you wish.
        // add your form and supporting HTML
        this.render(`<div>HTML</div>`);
        // initialize the plugin within InterroBot, from within iframe
-       await this.initData({}, []);    
+       await this.initData({}, []);
        // add handlers to the form
        const button = document.querySelector("button");
-       button.addEventListener("click", async (ev) => { 
+       button.addEventListener("click", async (ev) => {
            await this.process(); // where process() is a form handler
        });
    }
@@ -100,24 +100,24 @@ the exampleResultsHandler.
        // gather title words and running counts with a result handler
        const titleWords: Map<string, number> = new Map<string, number>();
        let resultsMap: Map<number, SearchResult>;
-       const exampleResultHandler = async (result: SearchResult, 
+       const exampleResultHandler = async (result: SearchResult,
            titleWordsMap: Map<string, number>) => {
            const terms: string[] = result.name.trim().split(/[\s\-—]+/g);
-           terms.forEach(term => titleWordsMap.set(term, 
+           terms.forEach(term => titleWordsMap.set(term,
                (titleWordsMap.get(term) ?? 0) + 1));
        }
        // projectId comes for free as a member of Plugin
        const projectId: number = this.getProjectId();
        // anything you put into InterroBot search, field or fulltext works
        // here we limit to HTML documents, which will have a <title> -> name
        const freeQueryString: string = "headers: text/html";
-       // pipe delimited fields you want retrieved. id and url come with 
+       // pipe delimited fields you want retrieved. id and url come with
        // the base model, everything else must be requested explicitly
        const fields: string = "name";
-       const internalHtmlPagesQuery = new SearchQuery(projectId, 
+       const internalHtmlPagesQuery = new SearchQuery(projectId,
            freeQueryString, fields, SearchQueryType.Any, false);
        // run each SearchResult through its handler, and we're done processing
-       await Search.execute(internalHtmlPagesQuery, resultsMap, "Processing…", 
+       await Search.execute(internalHtmlPagesQuery, resultsMap, "Processing…",
            async (result: SearchResult) => {
                await exampleResultHandler(result, titleWords);
            }

docs/index.html

@@ -8,9 +8,9 @@
    <a href="https://interro.bot/plugins/">Plugins</a> ·
    <a href="https://interro.bot/">InterroBot</a>
 <p>
-<p>Your web crawler just got superpowers. InterroBot plugins transform your web crawler into a customizable data powerhouse, unleashing unlimited potential for data extraction and analysis.</p>
-<p>InterroBot plugins are simple HTML/JS/CSS pages that transform raw web crawl data into profound insights, stunning visualizations, and interactive dashboards. With our flexible API, you can create custom plugins that analyze website content across entire domains, connecting with analytics, LLMs, or your favorite SaaS for deeper insights.</p>
-<p>Our plugin ecosystem is designed for versatility. Whether you're building proprietary tools, developing plugins for clients, or contributing to the open-source community, InterroBot plugins adapt to your needs. Available for Windows 10/11, macOS, and Android, our platform ensures your data analysis can happen wherever you work.</p>
+<p>InterroBot plugins transform your web crawler into, well... anything you want. With unrestricted API crawl data access, Interrobot plugins can bring your website analysis concepts to life.</p>
+<p>InterroBot plugins are simple HTML/JS/CSS pages that turn crawl data into insights, stunning visualizations, and interactive dashboards. With our flexible API, you can create custom plugins that analyze website content across entire domains, connecting with analytics, LLMs, or your favorite SaaS for deeper insights.</p>
+<p>The InterroBot plugin ecosystem is designed for power users. Whether you're building proprietary tools, developing plugins for clients, or contributing to the open-source community, InterroBot plugins adapt to your needs. Available for Windows 10/11, macOS, Linux, and Android, InterroBot plugins are everywhere you need them.</p>
 <a id="md:how-does-it-work" class="tsd-anchor"></a><h2 class="tsd-anchor-link">How Does it Work?<a href="#md:how-does-it-work" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>InterroBot hosts an iframe of your webpage and exposes an API from which you can pull data down for analysis.</p>
 <p>If you're familiar with vanilla TypeScript or JavaScript, creating a custom plugin script for InterroBot is remarkably straight forward. First you start with a <a href="https://raw.githubusercontent.com/interrobot/interrobot-plugin/refs/heads/master/examples/vanillajs/basic.html" target="_blank" class="external">bare-bones HTML file</a> and a script extending the Plugin base class.</p>
 <pre><code class="javascript"><span class="hl-0">// TypeScript vs. JavaScript, both are fine. See examples.</span><br/><span class="hl-1">import</span><span class="hl-2"> { </span><span class="hl-3">Plugin</span><span class="hl-2"> } </span><span class="hl-1">from</span><span class="hl-2"> </span><span class="hl-4">&quot;./src/ts/core/plugin&quot;</span><span class="hl-2">;</span><br/><span class="hl-5">class</span><span class="hl-2"> </span><span class="hl-6">BasicExamplePlugin</span><span class="hl-2"> </span><span class="hl-5">extends</span><span class="hl-2"> </span><span class="hl-6">Plugin</span><span class="hl-2"> {</span><br/><span class="hl-2">    </span><span class="hl-5">static</span><span class="hl-2"> </span><span class="hl-3">meta</span><span class="hl-2"> = {</span><br/><span class="hl-2">        </span><span class="hl-4">&quot;title&quot;</span><span class="hl-3">:</span><span class="hl-2"> </span><span class="hl-4">&quot;Example Plugin&quot;</span><span class="hl-2">,</span><br/><span class="hl-2">        </span><span class="hl-4">&quot;category&quot;</span><span class="hl-3">:</span><span class="hl-2"> </span><span class="hl-4">&quot;Example&quot;</span><span class="hl-2">,</span><br/><span class="hl-2">        </span><span class="hl-4">&quot;version&quot;</span><span class="hl-3">:</span><span class="hl-2"> </span><span class="hl-4">&quot;1.0.0&quot;</span><span class="hl-2">,</span><br/><span class="hl-2">        </span><span class="hl-4">&quot;author&quot;</span><span class="hl-3">:</span><span class="hl-2"> </span><span class="hl-4">&quot;InterroBot&quot;</span><span class="hl-2">,</span><br/><span class="hl-2">        </span><span class="hl-4">&quot;synopsis&quot;</span><span class="hl-3">:</span><span class="hl-2"> </span><span class="hl-4">`a basic plugin example`</span><span class="hl-2">,</span><br/><span class="hl-2">        </span><span class="hl-4">&quot;description&quot;</span><span class="hl-3">:</span><span class="hl-2"> </span><span class="hl-4">`This example is as simple as it gets.`</span><span class="hl-2">,</span><br/><span class="hl-2">    };</span><br/><span class="hl-2">    </span><span class="hl-5">constructor</span><span class="hl-2">() {</span><br/><span class="hl-2">        </span><span class="hl-5">super</span><span class="hl-2">();</span><br/><span class="hl-2">        </span><span class="hl-0">// index() has nothing to do with the crawl index, btw. it is</span><br/><span class="hl-2">        </span><span class="hl-0">// the plugin index (think index.html), a view that shows by</span><br/><span class="hl-2">        </span><span class="hl-0">// default, and would generally consist of a form or visualization.</span><br/><span class="hl-2">        </span><span class="hl-5">this</span><span class="hl-2">.</span><span class="hl-7">index</span><span class="hl-2">();</span><br/><span class="hl-2">    }</span><br/><span class="hl-2">}</span><br/><span class="hl-0">// configure to initialize when the page is ready</span><br/><span class="hl-3">Plugin</span><span class="hl-2">.</span><span class="hl-7">initialize</span><span class="hl-2">(</span><span class="hl-3">BasicExamplePlugin</span><span class="hl-2">);</span>
@@ -27,7 +27,7 @@
 </code><button type="button">Copy</button></pre>
 
 <p>The above snippets are pulled (and gently modified) from a plugin in the repository, <a href="https://github.com/interrobot/interrobot-plugin/blob/master/examples/vanillajs/basic.js" target="_blank" class="external">basic.js</a>. For more ideas getting started, check out the <a href="https://github.com/interrobot/interrobot-plugin/blob/master/examples/" target="_blank" class="external">examples</a> directory.</p>
-<a id="md:what-data-is-available-via-api" class="tsd-anchor"></a><h2 class="tsd-anchor-link">What data is available via API?<a href="#md:what-data-is-available-via-api" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>InterroBot's robust API provides plugin developers with access to crawled data, enabling deep analysis and useful customizations. This data forms the foundation of your plugin, allowing you to create insightful visualizations, perform complex analysis, or build interactive tools. Whether you're tracking SEO metrics, analyzing content structures, or developing custom reporting tools, our API offers the flexibility and depth you need. Below is an overview of the key data points available, organized by API endpoint:</p>
+<a id="md:what-data-is-available-via-api" class="tsd-anchor"></a><h2 class="tsd-anchor-link">What data is available via API?<a href="#md:what-data-is-available-via-api" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>InterroBot's API provides developers with access to crawled data, enabling analysis and useful customizations. This data allows you to create insightful visualizations, perform complex analysis, or build interactive tools. Whether you're tracking SEO metrics, analyzing content structures, or developing custom reporting tools, our API offers the flexibility and depth you need. Below is an overview of the key data points available, organized by API endpoint:</p>
 <a id="md:getprojects" class="tsd-anchor"></a><h3 class="tsd-anchor-link">GetProjects<a href="#md:getprojects" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>Retrieves a list of projects using the Plugin API.</p>
 <p><strong>Optional Fields</strong></p>
 <table>

package.json

@@ -0,0 +1,28 @@
+{
+    "name": "interrobot-plugin",
+    "version": "0.17.0",
+    "description": "Used in the creation of plugins (aka reports) that present data or visualizations for a website in aggregate, across site content. For use with InterroBot application.",
+    "main": "js/commonjs/interrobot-plugin.js",
+    "module": "js/es6/interrobot-plugin.js",
+    "repository": {
+      "type": "git",
+      "url": "git+https://github.com/interrobot/interrobot-plugin.git"
+    },
+    "scripts": {
+        "docs": "typedoc --entryPointStrategy expand --entryPoints \"src/**/*.ts\" --customCss ./docs-theme/interrobot-plugin.css"
+    },
+    "files": [
+      "js"
+    ],
+    "keywords": [
+      "javascript",
+      "InterroBot",
+      "plugin",
+      "webdev",
+      "SEO",
+      "crawler",
+      "spider"
+    ],
+    "author": "Ben Caulfield",
+    "license": "MPL-2.0"
+}

typedoc.json

@@ -3,9 +3,9 @@
     "navigationLinks": {
         "GitHub": "https://github.com/interrobot/interrobot-plugin",
         "InterroBot": "https://interro.bot"
-        
     },
     "titleLink": "https://interrobot.github.io/interrobot-plugin/",
-    "entryPoints": ["./src/ts"],
+    "entryPointStrategy": "expand",
+    "entryPoints": ["src/**/*.ts"],
     "out": "docs"
 }