adds support for custom URL lists crawls (InterroBot 2.10+)

Author: pragmar

dist/js/commonjs/core/api.d.ts

@@ -37,17 +37,18 @@ interface SearchResultJson {
 interface CrawlParams {
     id: number;
     project: number;
-    created: Date;
-    modified: Date;
+    created?: Date;
+    modified?: Date;
     complete?: boolean;
     time?: number;
     report?: any;
 }
 interface ProjectParams {
     id: number;
-    created: Date;
-    modified: Date;
     name?: string;
+    type?: string;
+    created?: Date;
+    modified?: Date;
     url?: string;
     urls?: string[];
     imageDataUri?: string;
@@ -70,7 +71,7 @@ declare class PluginData {
     private project;
     /**
      * Creates an instance of PluginData.
-     * @param params - PluginDataParams, collection of arguments.
+     * @param params - The plugin data parameters.
      */
     constructor(params: PluginDataParams);
     /**
@@ -123,7 +124,7 @@ declare class SearchQuery {
     readonly perPage: number;
     /**
      * Creates an instance of SearchQuery.
-     * @param params - SearchQueryParams, collection of arguments.
+     * @param params - The search query parameters.
      */
     constructor(params: SearchQueryParams);
     /**
@@ -232,15 +233,15 @@ declare class SearchResult {
  */
 declare class Crawl {
     id: number;
-    created: Date;
-    modified: Date;
     project: number;
     complete: boolean;
-    time: number;
-    report: any;
+    created?: Date;
+    modified?: Date;
+    time?: number;
+    report?: any;
     /**
      * Creates an instance of Crawl.
-     * @param params - CrawlParams, collection of arguments.
+     * @param params - The crawl parameters.
      */
     constructor(params: CrawlParams);
     /**
@@ -265,16 +266,17 @@ declare class Crawl {
  */
 declare class Project {
     id: number;
-    created: Date;
-    modified: Date;
+    created?: Date;
+    modified?: Date;
     name?: string;
+    type?: string;
     url?: string;
     urls?: string[];
     imageDataUri?: string;
     static readonly urlDeprectionWarning: string;
     /**
      * Creates an instance of Project.
-     * @param params - ProjectParams, collection of arguments.
+     * @param params - The project parameters.
      */
     constructor(params: ProjectParams);
     /**
@@ -301,4 +303,4 @@ declare class Project {
      */
     static getApiCrawls(project: number): Promise<Crawl[]>;
 }
-export { Project, Crawl, SearchQueryType, SearchQuery, Search, SearchResult, PluginData };
+export { Project, Crawl, SearchQueryType, SearchQuery, Search, SearchResult, SearchResultJson, PluginData };

dist/js/commonjs/core/api.js

@@ -33,7 +33,7 @@ var SearchQuerySortDirection;
 class PluginData {
     /**
      * Creates an instance of PluginData.
-     * @param params - PluginDataParams, collection of arguments.
+     * @param params - The plugin data parameters.
      */
     constructor(params) {
         var _a;
@@ -378,7 +378,7 @@ exports.PluginData = PluginData;
 class SearchQuery {
     /**
      * Creates an instance of SearchQuery.
-     * @param params - SearchQueryParams, collection of arguments.
+     * @param params - The search query parameters.
      */
     constructor(params) {
         var _a, _b, _c;
@@ -633,13 +633,13 @@ SearchResult.wordWhitespaceRe = /\s+/g;
 class Crawl {
     /**
      * Creates an instance of Crawl.
-     * @param params - CrawlParams, collection of arguments.
+     * @param params - The crawl parameters.
      */
     constructor(params) {
         this.id = -1;
+        this.project = -1;
         this.created = null;
         this.modified = null;
-        this.project = -1;
         this.time = -1;
         this.report = null;
         this.id = params.id;
@@ -690,21 +690,24 @@ exports.Crawl = Crawl;
 class Project {
     /**
      * Creates an instance of Project.
-     * @param params - ProjectParams, collection of arguments.
+     * @param params - The project parameters.
      */
     constructor(params) {
         this.id = -1;
         this.created = null;
         this.modified = null;
         this.name = null; // name to required when url shut down
+        this.type = null; // name to required when url shut down
         this.url = null; // deprecated
-        this.urls = [];
+        this.urls = null;
         this.imageDataUri = null;
         this.id = params.id;
+        this.name = params.name;
+        this.type = params.type;
         this.created = params.created;
         this.modified = params.modified;
         this.url = params.url;
-        this.name = params.name;
+        this.urls = params.urls;
         this.imageDataUri = params.imageDataUri;
     }
     /**
@@ -753,7 +756,7 @@ class Project {
     static async getApiProject(id) {
         const kwargs = {
             "projects": [id],
-            "fields": ["image", "created", "modified"],
+            "fields": ["image", "created", "modified", "urls"],
         };
         const projects = await plugin_js_1.Plugin.postApiRequest("GetProjects", kwargs);
         const results = projects.results;
@@ -765,13 +768,15 @@ class Project {
                 const modified = new Date(project.modified);
                 const name = project.name || project.url; // url is deprecated
                 const imageDataUri = project.image;
+                const urls = project.urls || null;
                 // return new Project(id, created, modified, url, imageDataUri);
                 return new Project({
                     id: id,
                     created: created,
                     modified: modified,
                     name: name,
-                    imageDataUri: imageDataUri
+                    imageDataUri: imageDataUri,
+                    urls: urls
                 });
             }
         }

dist/js/commonjs/core/plugin.d.ts

@@ -86,7 +86,7 @@ declare class Plugin {
      * Logs warning information to the console.
      * @param msg - The message to log.
      */
-    static logWarning(msg: string): void;
+    static logWarning(msg: string, ex?: Error): void;
     /**
      * Routes a message to the parent frame.
      * @param msg - The message to route.

dist/js/commonjs/core/plugin.js

@@ -221,8 +221,9 @@ class Plugin {
      * Logs warning information to the console.
      * @param msg - The message to log.
      */
-    static logWarning(msg) {
-        console.warn(`🤖 ${msg}`);
+    static logWarning(msg, ex = null) {
+        const newlinedError = ex ? `\n${ex}` : "";
+        console.warn(`🤖 ${msg}${newlinedError}`);
     }
     /**
      * Routes a message to the parent frame.

dist/js/commonjs/index.js

@@ -1,6 +1,6 @@
 "use strict";
 // this distribution is intended to be used with standard imports
-// exporting into a second namespace, for the sake of satisfying the index.js 
+// exporting into a second namespace, for the sake of satisfying the index.js
 // gods will lead to needless confusion. namespacing can be done with a wrapper.
 // see examples/vanillats/interrobot-plugin.ts for a classic recipe
 Object.defineProperty(exports, "__esModule", { value: true });

dist/js/es6/core/api.d.ts

@@ -37,17 +37,18 @@ interface SearchResultJson {
 interface CrawlParams {
     id: number;
     project: number;
-    created: Date;
-    modified: Date;
+    created?: Date;
+    modified?: Date;
     complete?: boolean;
     time?: number;
     report?: any;
 }
 interface ProjectParams {
     id: number;
-    created: Date;
-    modified: Date;
     name?: string;
+    type?: string;
+    created?: Date;
+    modified?: Date;
     url?: string;
     urls?: string[];
     imageDataUri?: string;
@@ -70,7 +71,7 @@ declare class PluginData {
     private project;
     /**
      * Creates an instance of PluginData.
-     * @param params - PluginDataParams, collection of arguments.
+     * @param params - The plugin data parameters.
      */
     constructor(params: PluginDataParams);
     /**
@@ -123,7 +124,7 @@ declare class SearchQuery {
     readonly perPage: number;
     /**
      * Creates an instance of SearchQuery.
-     * @param params - SearchQueryParams, collection of arguments.
+     * @param params - The search query parameters.
      */
     constructor(params: SearchQueryParams);
     /**
@@ -232,15 +233,15 @@ declare class SearchResult {
  */
 declare class Crawl {
     id: number;
-    created: Date;
-    modified: Date;
     project: number;
     complete: boolean;
-    time: number;
-    report: any;
+    created?: Date;
+    modified?: Date;
+    time?: number;
+    report?: any;
     /**
      * Creates an instance of Crawl.
-     * @param params - CrawlParams, collection of arguments.
+     * @param params - The crawl parameters.
      */
     constructor(params: CrawlParams);
     /**
@@ -265,16 +266,17 @@ declare class Crawl {
  */
 declare class Project {
     id: number;
-    created: Date;
-    modified: Date;
+    created?: Date;
+    modified?: Date;
     name?: string;
+    type?: string;
     url?: string;
     urls?: string[];
     imageDataUri?: string;
     static readonly urlDeprectionWarning: string;
     /**
      * Creates an instance of Project.
-     * @param params - ProjectParams, collection of arguments.
+     * @param params - The project parameters.
      */
     constructor(params: ProjectParams);
     /**
@@ -301,4 +303,4 @@ declare class Project {
      */
     static getApiCrawls(project: number): Promise<Crawl[]>;
 }
-export { Project, Crawl, SearchQueryType, SearchQuery, Search, SearchResult, PluginData };
+export { Project, Crawl, SearchQueryType, SearchQuery, Search, SearchResult, SearchResultJson, PluginData };

dist/js/es6/core/api.js

@@ -29,7 +29,7 @@ var SearchQuerySortDirection;
 class PluginData {
     /**
      * Creates an instance of PluginData.
-     * @param params - PluginDataParams, collection of arguments.
+     * @param params - The plugin data parameters.
      */
     constructor(params) {
         var _a;
@@ -373,7 +373,7 @@ class PluginData {
 class SearchQuery {
     /**
      * Creates an instance of SearchQuery.
-     * @param params - SearchQueryParams, collection of arguments.
+     * @param params - The search query parameters.
      */
     constructor(params) {
         var _a, _b, _c;
@@ -625,13 +625,13 @@ SearchResult.wordWhitespaceRe = /\s+/g;
 class Crawl {
     /**
      * Creates an instance of Crawl.
-     * @param params - CrawlParams, collection of arguments.
+     * @param params - The crawl parameters.
      */
     constructor(params) {
         this.id = -1;
+        this.project = -1;
         this.created = null;
         this.modified = null;
-        this.project = -1;
         this.time = -1;
         this.report = null;
         this.id = params.id;
@@ -681,21 +681,24 @@ class Crawl {
 class Project {
     /**
      * Creates an instance of Project.
-     * @param params - ProjectParams, collection of arguments.
+     * @param params - The project parameters.
      */
     constructor(params) {
         this.id = -1;
         this.created = null;
         this.modified = null;
         this.name = null; // name to required when url shut down
+        this.type = null; // name to required when url shut down
         this.url = null; // deprecated
-        this.urls = [];
+        this.urls = null;
         this.imageDataUri = null;
         this.id = params.id;
+        this.name = params.name;
+        this.type = params.type;
         this.created = params.created;
         this.modified = params.modified;
         this.url = params.url;
-        this.name = params.name;
+        this.urls = params.urls;
         this.imageDataUri = params.imageDataUri;
     }
     /**
@@ -744,7 +747,7 @@ class Project {
     static async getApiProject(id) {
         const kwargs = {
             "projects": [id],
-            "fields": ["image", "created", "modified"],
+            "fields": ["image", "created", "modified", "urls"],
         };
         const projects = await Plugin.postApiRequest("GetProjects", kwargs);
         const results = projects.results;
@@ -756,13 +759,15 @@ class Project {
                 const modified = new Date(project.modified);
                 const name = project.name || project.url; // url is deprecated
                 const imageDataUri = project.image;
+                const urls = project.urls || null;
                 // return new Project(id, created, modified, url, imageDataUri);
                 return new Project({
                     id: id,
                     created: created,
                     modified: modified,
                     name: name,
-                    imageDataUri: imageDataUri
+                    imageDataUri: imageDataUri,
+                    urls: urls
                 });
             }
         }

dist/js/es6/core/plugin.d.ts

@@ -86,7 +86,7 @@ declare class Plugin {
      * Logs warning information to the console.
      * @param msg - The message to log.
      */
-    static logWarning(msg: string): void;
+    static logWarning(msg: string, ex?: Error): void;
     /**
      * Routes a message to the parent frame.
      * @param msg - The message to route.