Refactor to use new article type classes (#124)

* Seed pages_db.json with exported JSON from Cargo tables

* Add pageName and pageId to article type interfaces

* Add ways to construct page classes

* Refactor page entry classes to article type classes

* Comment out updating pages_db.json from GitHub

* Refactor constructing page instances to use new class methods

* Refactor checking number of results found to use totalPagesFound

* Fix tests

Author: schang1146

data/pages_db.json

@@ -5,7 +5,8 @@
 import browser from 'webextension-polyfill';
 import DOMMessenger from './dom-messenger';
 import { DOMMessengerAction, IShowInPageNotificationPayload } from './dom-messenger.types';
-import { IPageEntry, PageEntry } from '@/database';
+import { IPage } from '@/models/page';
+import { CompanyPage } from '@/models/company';
 
 type MessagePayload =
     | { action: DOMMessengerAction.DOM_QUERY_SELECTOR_ALL; selector: string }
@@ -15,7 +16,7 @@ type MessagePayload =
     | { action: DOMMessengerAction.DOM_CREATE_ELEMENT; id: string; element: string; html: string }
     | ({
           action: DOMMessengerAction.DOM_SHOW_IN_PAGE_NOTIFICATION;
-          pages: IPageEntry[];
+          pages: IPage[];
       } & IShowInPageNotificationPayload);
 
 type MessageListener = (
@@ -224,7 +225,15 @@ describe('DOMMessenger', () => {
             const sendResponse = jest.fn();
             const testMessage = 'Hello from test!';
 
-            const testPage = new PageEntry({ pageId: 1, pageTitle: 'title', popupText: 'text', category: 'category' });
+            const testPage = CompanyPage.fromCargoExport({
+                PageID: '1',
+                PageName: 'title',
+                Description: 'test company',
+                Industry: '',
+                ParentCompany: '',
+                Type: '',
+                Website: '',
+            });
 
             const pages = [testPage];
 
@@ -251,7 +260,7 @@ describe('DOMMessenger', () => {
             expect(containerElement).not.toBeNull();
             expect(containerElement.nodeName.toLowerCase()).toBe('div');
             expect(containerElement.textContent).toContain(testMessage);
-            expect(containerElement.textContent).toContain(testPage.pageTitle);
+            expect(containerElement.textContent).toContain(testPage.pageName);
             expect(containerElement?.children.length).toBeGreaterThan(0);
             expect(containerElement.textContent).toContain(testMessage);
 

src/common/helpers/dom-messenger.test.ts

@@ -8,7 +8,7 @@ import { createRoot } from 'react-dom/client';
 
 import Inspagenotification from '@/ui/inpagenotification/Inspagenotification';
 
-import { IPageEntry } from '@/database';
+import { IPage, Page } from '@/models/page';
 
 type DOMMessagePayload =
     | { action: DOMMessengerAction.DOM_QUERY_SELECTOR_ALL; selector: string }
@@ -18,7 +18,7 @@ type DOMMessagePayload =
     | { action: DOMMessengerAction.DOM_CREATE_ELEMENT; id: string; element: string; html: string }
     | ({
           action: DOMMessengerAction.DOM_SHOW_IN_PAGE_NOTIFICATION;
-          pages: IPageEntry[];
+          pages: IPage[];
       } & IShowInPageNotificationPayload);
 
 declare global {
@@ -72,13 +72,13 @@ class DOMMessenger implements IDOMMessengerInterface {
         });
     }
 
-    public async showInPageNotification(message: string, pages: IPageEntry[]): Promise<unknown> {
+    public async showInPageNotification(message: string, pages: Page[]): Promise<unknown> {
         console.log('showInPageNotification1: ', message);
         console.log('showInPageNotification2: ', pages);
         return await this.sendMessageToCurrentTab({
             action: DOMMessengerAction.DOM_SHOW_IN_PAGE_NOTIFICATION,
             message: message,
-            pages: pages,
+            pages: pages.map((page) => page.toJSON()),
         });
     }
 
@@ -262,7 +262,7 @@ class DOMMessenger implements IDOMMessengerInterface {
         return DOMMessenger.elementId;
     }
 
-    private static displayNotification(message: string, pages: IPageEntry[]): void {
+    private static displayNotification(message: string, pages: IPage[]): void {
         const containerId = DOMMessenger.containerId();
 
         /**

src/common/helpers/dom-messenger.ts

@@ -20,8 +20,8 @@ export abstract class BaseDomainScanner implements IContentScannerPlugin {
         console.log(`${scannerId}: Attempting search: ${description}`);
         try {
             const results = searchFn();
-            if (results.pageEntries.length > 0) {
-                console.log(`${scannerId}: Found ${results.pageEntries.length.toString()} pages via ${description}.`);
+            if (results.totalPagesFound > 0) {
+                console.log(`${scannerId}: Found ${results.totalPagesFound.toString()} pages via ${description}.`);
                 combinedResults.addPageEntries(results.pageEntries);
                 found = true;
             } else {

src/content-scanners/base-domain-scanner.ts

@@ -1,5 +1,5 @@
 import { IContentScannerPlugin, IElementData, IScanParameters } from '@/common/services/content-scanner.types';
-import { CATWikiPageSearchResults, PageEntry } from '@/database';
+import { CATWikiPageSearchResults } from '@/database';
 import browser from 'webextension-polyfill';
 
 // Simple test for simple test page, e.g.
@@ -52,10 +52,10 @@ export class TestScanner implements IContentScannerPlugin {
 
                 if (searchResult.totalPagesFound) {
                     console.log('Adding the CAT html: ', alertImgUrl);
-                    const pageEntry = pageResults.pageEntries[0] as PageEntry;
+                    const pageEntry = pageResults.pageEntries[0];
                     console.dir(pageEntry);
                     const pageUrl: string = pageEntry.url();
-                    const popupText: string = pageEntry.popupText;
+                    const popupText: string = pageEntry.description;
                     await params.dom.createElement(
                         divId,
                         'p',