@tolinax/ayoune-interfaces 2024.9.0 → 2024.9.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/interfaces/IKeywordResearch.d.ts +91 -105
  2. package/interfaces/IKeywordResearch.js +5 -0
  3. package/package.json +1 -1
package/interfaces/IKeywordResearch.d.ts CHANGED
@@ -1,4 +1,87 @@
1
1
  import { IDefaultFields } from "./IDefaultFields";
2
+ import { ICostRun } from "./IMarketResearch";
3
+ interface IFetchSettings {
4
+ provider: string;
5
+ withAds: boolean;
6
+ withCost: boolean;
7
+ costs: boolean;
8
+ costOnly: boolean;
9
+ synonyms: boolean;
10
+ questions: boolean;
11
+ prepositions: boolean;
12
+ comparisons: boolean;
13
+ alphabeticals: boolean;
14
+ monitorAdHijacking: boolean;
15
+ monitorBrandBidding: boolean;
16
+ manageBrandBidding: boolean;
17
+ monitorPla: boolean;
18
+ monitorKeywordInclusion: boolean;
19
+ keepResults: boolean;
20
+ takeScreenShot: boolean;
21
+ takeFullScreenShot: boolean;
22
+ checkForCampaign: boolean;
23
+ positionsToMonitor: number[];
24
+ }
25
+ interface IResearchConfig {
26
+ frequency: number;
27
+ active: boolean;
28
+ permanently: boolean;
29
+ crawlUntil?: Date;
30
+ crawlDuration: number;
31
+ advancedCrawling: boolean;
32
+ start: number;
33
+ evaluationDuration: number;
34
+ devices: string[];
35
+ matchType: string;
36
+ lastCheck?: Date;
37
+ nextCheck?: Date;
38
+ }
39
+ interface ICoreCrawlingConfig {
40
+ regions: string[];
41
+ timeFrames: {
42
+ dow: number;
43
+ from: number;
44
+ to: number;
45
+ frequency: number;
46
+ }[];
47
+ }
48
+ interface IResearchMeta {
49
+ callsPerDay: number;
50
+ callsPerMonth: number;
51
+ regionStats: {
52
+ region?: string;
53
+ crawls: number;
54
+ }[];
55
+ }
56
+ interface IAdHijackerConfig {
57
+ mode?: "tracker" | "chain";
58
+ trackerDomain?: string;
59
+ redirectChain: {
60
+ url?: string;
61
+ }[];
62
+ resolveOthers: boolean;
63
+ excludes: {
64
+ domain?: string;
65
+ note?: string;
66
+ }[];
67
+ }
68
+ interface IBrandBidderConfig {
69
+ brands: {
70
+ brand?: string;
71
+ }[];
72
+ blackList: {
73
+ domain?: string;
74
+ note?: string;
75
+ }[];
76
+ whiteList: {
77
+ domain?: string;
78
+ note?: string;
79
+ }[];
80
+ partnerList: {
81
+ domain?: string;
82
+ note?: string;
83
+ }[];
84
+ }
2
85
  export interface IKeywordResearch extends IDefaultFields {
3
86
  name: string;
4
87
  _customerID: ObjectId;
@@ -18,113 +101,16 @@ export interface IKeywordResearch extends IDefaultFields {
18
101
  fetchStatus: string;
19
102
  keywords?: string[];
20
103
  market: string;
21
- config: {
22
- frequency: number;
23
- active: boolean;
24
- permanently: boolean;
25
- crawlUntil?: Date;
26
- crawlDuration: number;
27
- advancedCrawling: boolean;
28
- start: number;
29
- evaluationDuration: number;
30
- devices: string[];
31
- matchType: string;
32
- lastCheck?: Date;
33
- nextCheck?: Date;
34
- };
35
- crawlingConfig: {
36
- regions: string[];
37
- timeFrames: {
38
- dow: number;
39
- from: number;
40
- to: number;
41
- frequency: number;
42
- }[];
43
- };
44
- meta: {
45
- callsPerDay: number;
46
- callsPerMonth: number;
47
- regionStats: {
48
- region?: string;
49
- crawls: number;
50
- }[];
51
- };
52
- fetchSettings: {
53
- provider: string;
54
- withAds: boolean;
55
- withCost: boolean;
56
- costs: boolean;
57
- costOnly: boolean;
58
- synonyms: boolean;
59
- questions: boolean;
60
- prepositions: boolean;
61
- comparisons: boolean;
62
- alphabeticals: boolean;
63
- monitorAdHijacking: boolean;
64
- monitorBrandBidding: boolean;
65
- manageBrandBidding: boolean;
66
- monitorPla: boolean;
67
- monitorKeywordInclusion: boolean;
68
- keepResults: boolean;
69
- checkForCampaign: boolean;
70
- positionsToMonitor: number[];
71
- };
72
- brandBidderConfig: {
73
- brands: {
74
- brand?: string;
75
- }[];
76
- blackList: {
77
- domain?: string;
78
- note?: string;
79
- }[];
80
- whiteList: {
81
- domain?: string;
82
- note?: string;
83
- }[];
84
- partnerList: {
85
- domain?: string;
86
- note?: string;
87
- }[];
88
- };
104
+ config: IResearchConfig;
105
+ crawlingConfig: ICoreCrawlingConfig;
106
+ meta: IResearchMeta;
107
+ fetchSettings: IFetchSettings;
108
+ brandBidderConfig: IBrandBidderConfig;
89
109
  ownDisplayUrls: {
90
110
  domain?: string;
91
111
  }[];
92
- adHijackingConfig: {
93
- mode?: "tracker" | "chain";
94
- trackerDomain?: string;
95
- redirectChain: {
96
- url?: string;
97
- }[];
98
- resolveOthers: boolean;
99
- excludes: {
100
- domain?: string;
101
- note?: string;
102
- }[];
103
- };
112
+ adHijackingConfig: IAdHijackerConfig;
104
113
  maxCPCs: number[];
105
- costRuns: {
106
- createdAt: Date;
107
- results: {
108
- _keyword?: ObjectId;
109
- keyword?: string;
110
- maxCPC: number;
111
- minCPC: number;
112
- avgCPC: number;
113
- maxCPD: number;
114
- minCPD: number;
115
- avgCPD: number;
116
- maxClicks: number;
117
- minClicks: number;
118
- avgClicks: number;
119
- maxCost: number;
120
- minCost: number;
121
- avgCost: number;
122
- maxImpressions: number;
123
- minImpressions: number;
124
- avgImpressions: number;
125
- breakPointMin: number;
126
- breakPointMax: number;
127
- breakPointAvg: number;
128
- }[];
129
- }[];
114
+ costRuns: ICostRun[];
130
115
  }
116
+ export {};
package/interfaces/IKeywordResearch.js CHANGED
@@ -1,2 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ ;
4
+ ;
5
+ ;
6
+ ;
7
+ ;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tolinax/ayoune-interfaces",
3
- "version": "2024.9.0",
3
+ "version": "2024.9.1",
4
4
  "description": "Houses TypeScript interfaces for aYOUne",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",