@tolinax/ayoune-interfaces 2024.9.0 → 2024.9.2

package/interfaces/IKeywordResearch.d.ts

@@ -1,4 +1,87 @@
 import { IDefaultFields } from "./IDefaultFields";
+import { ICostRun } from "./IMarketResearch";
+interface IFetchSettings {
+    provider: string;
+    withAds: boolean;
+    withCost: boolean;
+    costs: boolean;
+    costOnly: boolean;
+    synonyms: boolean;
+    questions: boolean;
+    prepositions: boolean;
+    comparisons: boolean;
+    alphabeticals: boolean;
+    monitorAdHijacking: boolean;
+    monitorBrandBidding: boolean;
+    manageBrandBidding: boolean;
+    monitorPla: boolean;
+    monitorKeywordInclusion: boolean;
+    keepResults: boolean;
+    takeScreenShot: boolean;
+    takeFullScreenShot: boolean;
+    checkForCampaign: boolean;
+    positionsToMonitor: number[];
+}
+interface IResearchConfig {
+    frequency: number;
+    active: boolean;
+    permanently: boolean;
+    crawlUntil?: Date;
+    crawlDuration: number;
+    advancedCrawling: boolean;
+    start: number;
+    evaluationDuration: number;
+    devices: string[];
+    matchType: string;
+    lastCheck?: Date;
+    nextCheck?: Date;
+}
+interface ICoreCrawlingConfig {
+    regions: string[];
+    timeFrames: {
+        dow: number;
+        from: number;
+        to: number;
+        frequency: number;
+    }[];
+}
+interface IResearchMeta {
+    callsPerDay: number;
+    callsPerMonth: number;
+    regionStats: {
+        region?: string;
+        crawls: number;
+    }[];
+}
+interface IAdHijackerConfig {
+    mode?: "tracker" | "chain";
+    trackerDomain?: string;
+    redirectChain: {
+        url?: string;
+    }[];
+    resolveOthers: boolean;
+    excludes: {
+        domain?: string;
+        note?: string;
+    }[];
+}
+interface IBrandBidderConfig {
+    brands: {
+        brand?: string;
+    }[];
+    blackList: {
+        domain?: string;
+        note?: string;
+    }[];
+    whiteList: {
+        domain?: string;
+        note?: string;
+    }[];
+    partnerList: {
+        domain?: string;
+        note?: string;
+    }[];
+}
 export interface IKeywordResearch extends IDefaultFields {
     name: string;
     _customerID: ObjectId;
@@ -18,113 +101,16 @@ export interface IKeywordResearch extends IDefaultFields {
     fetchStatus: string;
     keywords?: string[];
     market: string;
-    config: {
-        frequency: number;
-        active: boolean;
-        permanently: boolean;
-        crawlUntil?: Date;
-        crawlDuration: number;
-        advancedCrawling: boolean;
-        start: number;
-        evaluationDuration: number;
-        devices: string[];
-        matchType: string;
-        lastCheck?: Date;
-        nextCheck?: Date;
-    };
-    crawlingConfig: {
-        regions: string[];
-        timeFrames: {
-            dow: number;
-            from: number;
-            to: number;
-            frequency: number;
-        }[];
-    };
-    meta: {
-        callsPerDay: number;
-        callsPerMonth: number;
-        regionStats: {
-            region?: string;
-            crawls: number;
-        }[];
-    };
-    fetchSettings: {
-        provider: string;
-        withAds: boolean;
-        withCost: boolean;
-        costs: boolean;
-        costOnly: boolean;
-        synonyms: boolean;
-        questions: boolean;
-        prepositions: boolean;
-        comparisons: boolean;
-        alphabeticals: boolean;
-        monitorAdHijacking: boolean;
-        monitorBrandBidding: boolean;
-        manageBrandBidding: boolean;
-        monitorPla: boolean;
-        monitorKeywordInclusion: boolean;
-        keepResults: boolean;
-        checkForCampaign: boolean;
-        positionsToMonitor: number[];
-    };
-    brandBidderConfig: {
-        brands: {
-            brand?: string;
-        }[];
-        blackList: {
-            domain?: string;
-            note?: string;
-        }[];
-        whiteList: {
-            domain?: string;
-            note?: string;
-        }[];
-        partnerList: {
-            domain?: string;
-            note?: string;
-        }[];
-    };
+    config: IResearchConfig;
+    crawlingConfig: ICoreCrawlingConfig;
+    meta: IResearchMeta;
+    fetchSettings: IFetchSettings;
+    brandBidderConfig: IBrandBidderConfig;
     ownDisplayUrls: {
         domain?: string;
     }[];
-    adHijackingConfig: {
-        mode?: "tracker" | "chain";
-        trackerDomain?: string;
-        redirectChain: {
-            url?: string;
-        }[];
-        resolveOthers: boolean;
-        excludes: {
-            domain?: string;
-            note?: string;
-        }[];
-    };
+    adHijackingConfig: IAdHijackerConfig;
     maxCPCs: number[];
-    costRuns: {
-        createdAt: Date;
-        results: {
-            _keyword?: ObjectId;
-            keyword?: string;
-            maxCPC: number;
-            minCPC: number;
-            avgCPC: number;
-            maxCPD: number;
-            minCPD: number;
-            avgCPD: number;
-            maxClicks: number;
-            minClicks: number;
-            avgClicks: number;
-            maxCost: number;
-            minCost: number;
-            avgCost: number;
-            maxImpressions: number;
-            minImpressions: number;
-            avgImpressions: number;
-            breakPointMin: number;
-            breakPointMax: number;
-            breakPointAvg: number;
-        }[];
-    }[];
+    costRuns: ICostRun[];
 }
+export {};

package/interfaces/IKeywordResearch.js

@@ -1,2 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+;
+;
+;
+;
+;

package/interfaces/ISetting.d.ts

@@ -1,4 +1,5 @@
 import { IDefaultFields } from "./IDefaultFields";
+import { ISEOAttributes } from "./ISEOAttributes";
 interface AiSettings {
     useAI?: boolean;
     primingMessage?: string;
@@ -81,6 +82,14 @@ interface ColorsSettings {
     error?: string;
     info?: string;
 }
+interface FontsSettings {
+    brand?: string;
+    primary?: string;
+    secondary?: string;
+    accent?: string;
+    error?: string;
+    info?: string;
+}
 interface RewardsSettings {
     playSound?: boolean;
     sound?: string;
@@ -640,6 +649,21 @@ interface ProductsSettings {
     lockProductsAfterApprove?: boolean;
     reCheckPriceOnAmountChange?: boolean;
 }
+interface SlidesSettings {
+    active: boolean;
+    title: string;
+    defaultLanguage: string;
+    description: string;
+    color1: string;
+    color2: string;
+    useIcon: boolean;
+    showChat: boolean;
+    chatBot: boolean;
+    tacLink: string;
+    imprintLink: string;
+    privacyLink: string;
+    seo: ISEOAttributes;
+}
 export interface ISetting extends IDefaultFields {
     _customerID: ObjectId;
     ai: AiSettings;
@@ -649,6 +673,7 @@ export interface ISetting extends IDefaultFields {
     setup: SetupSettings;
     formats: FormatsSettings;
     colors: ColorsSettings;
+    fonts: FontsSettings;
     useRewards?: boolean;
     rewards: RewardsSettings;
     attention: AttentionSettings;
@@ -684,6 +709,7 @@ export interface ISetting extends IDefaultFields {
     pim: PimSettings;
     marketplace: MarketplaceSettings;
     products: ProductsSettings;
+    slides: SlidesSettings;
     [x: string]: any;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tolinax/ayoune-interfaces",
-  "version": "2024.9.0",
+  "version": "2024.9.2",
   "description": "Houses TypeScript interfaces for aYOUne",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",