Add ScraperInterface and DataProcessorInterface

src/index.ts

@@ -1,5 +1,7 @@
 export { DataProcessor } from './modules/data-processor/data-processor.class'
+export { DataProcessorInterface } from './modules/data-processor/data-processor.interface'
 export { DataEntity } from './modules/scheduler/data-entity.class'
 export { Scheduler } from './modules/scheduler/scheduler.class'
 export { UrlEntity } from './modules/scheduler/url-entity.class'
 export { Scraper } from './modules/scraper/scraper.class'
+export { ScraperInterface } from './modules/scraper/scraper.interface'

src/modules/data-processor/data-processor.class.ts

@@ -2,11 +2,12 @@ import pino, { Logger } from 'pino'
 import { DataProcessingResult } from './data-processing-result.interface'
 import { DataProcessorOptions } from './data-processor-options.class'
 import { DataProcessorOptionsInterface } from './data-processor-options.interface'
+import { DataProcessorInterface } from './data-processor.interface'
 
 /**
- * Data processor
+ * Data processor class
  */
-export abstract class DataProcessor {
+export abstract class DataProcessor implements DataProcessorInterface {
   private readonly logger: Logger
 
   constructor(options: DataProcessorOptionsInterface = {}) {

src/modules/data-processor/data-processor.interface.ts

@@ -0,0 +1,11 @@
+import { DataProcessingResult } from './data-processing-result.interface'
+
+/**
+ * Data processor interface
+ */
+export interface DataProcessorInterface {
+  /**
+   * Run
+   */
+  run(data: object): Promise<DataProcessingResult>
+}

src/modules/scheduler/data-entity.class.ts

@@ -1,12 +1,12 @@
-import { DataProcessor } from '../data-processor/data-processor.class'
+import { DataProcessorInterface } from '../data-processor/data-processor.interface'
 
 /** Data entity */
 export class DataEntity {
   data: object
-  dataProcessor: DataProcessor
+  dataProcessor: DataProcessorInterface
   retryCount = -1
 
-  constructor(data: object, dataProcessor: DataProcessor) {
+  constructor(data: object, dataProcessor: DataProcessorInterface) {
     this.data = data
     this.dataProcessor = dataProcessor
   }

src/modules/scheduler/url-entity.class.ts

@@ -1,12 +1,12 @@
-import { Scraper } from '../scraper/scraper.class'
+import { ScraperInterface } from '../scraper/scraper.interface'
 
 /** URL entity */
 export class UrlEntity {
   url: string
-  scraper: Scraper
+  scraper: ScraperInterface
   retryCount = -1
 
-  constructor(url: string, scraper: Scraper) {
+  constructor(url: string, scraper: ScraperInterface) {
     this.url = url
     this.scraper = scraper
   }

src/modules/scraper/scraper.class.ts

@@ -6,12 +6,13 @@ import { ParsingMeta } from './parsing-meta.interface'
 import { ParsingResult } from './parsing-result.interface'
 import { ScraperOptions } from './scraper-options.class'
 import { ScraperOptionsInterface } from './scraper-options.interface'
+import { ScraperInterface } from './scraper.interface'
 import { ScrapingResult } from './scraping-result.interface'
 
 /**
- * Scraper
+ * Scraper class
  */
-export abstract class Scraper {
+export abstract class Scraper implements ScraperInterface {
   private readonly axios: AxiosInstance
   protected readonly userAgents: string[]
   protected readonly proxies: HttpProxy[]

src/modules/scraper/scraper.interface.ts

@@ -0,0 +1,11 @@
+import { ScrapingResult } from './scraping-result.interface'
+
+/**
+ * Scraper interface
+ */
+export interface ScraperInterface {
+  /**
+   * Run
+   */
+  run(url: string): Promise<ScrapingResult>
+}