@tolinax/ayoune-interfaces 2024.4.25 → 2024.4.27

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/IAd.d.ts +43 -39
  2. package/interfaces/IDataSource.d.ts +31 -18
  3. package/package.json +1 -1
package/interfaces/IAd.d.ts CHANGED
@@ -1,37 +1,41 @@
1
1
  import { IDefaultFields } from "./IDefaultFields";
2
2
  export interface IAd extends IDefaultFields {
3
3
  _id: string;
4
- archived: string;
4
+ archived: boolean;
5
5
  lab: boolean;
6
6
  environment: "production" | "lab" | "all";
7
- _customerID: ObjectId;
8
- _clientID: ObjectId[];
9
- _subID: ObjectId[];
10
- _type: ObjectId;
11
- _campaign: ObjectId;
12
- _serps: ObjectId[];
7
+ _customerID?: ObjectId;
8
+ _clientID?: ObjectId[];
9
+ _subID?: ObjectId[];
10
+ _type?: ObjectId;
11
+ _campaign?: ObjectId;
12
+ _serps?: ObjectId[];
13
13
  createdAt: Date;
14
- first_find: Date;
15
- last_find: Date;
16
- totalResults: number;
17
- totalDesktopResults: number;
18
- totalMobileResults: number;
19
- totalTabletResults: number;
14
+ totalResults?: number;
15
+ totalDesktopResults?: number;
16
+ totalMobileResults?: number;
17
+ avgPosition?: number;
18
+ terms?: {
19
+ _id: false;
20
+ _keyword: ObjectId;
21
+ term: string;
22
+ avgPosition: number;
23
+ }[];
20
24
  locale: string;
21
- advertiser: string;
25
+ advertiser?: string;
22
26
  title: string;
23
- phone: string;
27
+ phone?: string;
24
28
  abstract: string;
25
29
  displayUrl: string;
26
- trackingUrl: string;
30
+ trackingUrl?: string;
27
31
  linkUrl: string;
28
32
  websiteUrl: string;
29
- image: string;
30
- app: boolean;
31
- keywordInclusion: boolean;
32
- keywordInclusionInTitle: boolean;
33
- keywordInclusionInAbstract: boolean;
34
- brandBidding: {
33
+ image?: string;
34
+ app?: boolean;
35
+ keywordInclusion?: boolean;
36
+ keywordInclusionInTitle?: boolean;
37
+ keywordInclusionInAbstract?: boolean;
38
+ brandBidding?: {
35
39
  isTrademarkViolation: boolean;
36
40
  isOwn: boolean;
37
41
  isBrandBidder: boolean;
@@ -41,7 +45,7 @@ export interface IAd extends IDefaultFields {
41
45
  brandInText: boolean;
42
46
  brandTerm: string;
43
47
  };
44
- adHijacking: {
48
+ adHijacking?: {
45
49
  destination: string;
46
50
  destinationDomain: string;
47
51
  isAffiliate: boolean;
@@ -58,37 +62,37 @@ export interface IAd extends IDefaultFields {
58
62
  isAffiliate: boolean;
59
63
  }[];
60
64
  };
61
- siteLinks: {
65
+ siteLinks?: {
62
66
  title: string;
63
67
  link: string;
64
68
  snippets: any;
65
69
  }[];
66
- extensions: {
70
+ extensions?: {
67
71
  title: string;
68
72
  link: string;
69
73
  snippets: any;
70
74
  }[];
71
- protocol: string;
72
- address: string;
73
- port: string;
74
- ip: string;
75
- hostname: string;
76
- subdomain: string;
77
- domain: string;
78
- path: string;
79
- parameters: {
75
+ protocol?: string;
76
+ address?: string;
77
+ port?: string;
78
+ ip?: string;
79
+ hostname?: string;
80
+ subdomain?: string;
81
+ domain?: string;
82
+ path?: string;
83
+ parameters?: {
80
84
  key: string;
81
85
  value: string;
82
86
  }[];
83
- IABCategories: {
87
+ IABCategories?: {
84
88
  _id: ObjectId;
85
89
  label: string;
86
90
  parent: string;
87
91
  score: number;
88
92
  confident: boolean;
89
93
  }[];
90
- mainCategory: string;
91
- mainCategoryLabel: string;
92
- subCategory: string;
93
- subCategoryLabel: string;
94
+ mainCategory?: string;
95
+ mainCategoryLabel?: string;
96
+ subCategory?: string;
97
+ subCategoryLabel?: string;
94
98
  }
package/interfaces/IDataSource.d.ts CHANGED
@@ -1,33 +1,46 @@
1
1
  import { IDefaultFields } from "./IDefaultFields";
2
2
  export interface IDataSource extends IDefaultFields {
3
- source: "rest" | "graph" | "aggregation";
4
- storeOutput: boolean;
5
- storeOnModel: "faqs" | "glossar" | "wikipages" | "products" | "productgroups" | "productdivisions" | "posts" | "quotes" | "";
6
- restEndpoint: string;
7
- restBaseEndpoint: string;
8
- restFullEndpoint: string;
9
- params: {
3
+ source: "url" | "rest" | "graph" | "aggregation";
4
+ storeOutput?: boolean;
5
+ storeOnModel?: "faqs" | "glossar" | "wikipages" | "products" | "productgroups" | "productdivisions" | "posts" | "quotes" | "";
6
+ restEndpoint?: {
7
+ endpoint: string;
8
+ host: string;
9
+ method: string;
10
+ modelName: string;
11
+ nameSpace: string;
12
+ operationId: string;
13
+ url?: string;
14
+ };
15
+ restBaseEndpoint?: string;
16
+ restFullEndpoint?: string;
17
+ url?: string;
18
+ params?: {
10
19
  key: string;
11
20
  value: string;
12
21
  }[];
13
- queryParams: {
22
+ headers?: {
14
23
  key: string;
15
24
  value: string;
16
25
  }[];
17
- inputParams: {
26
+ queryParams?: {
27
+ key: string;
28
+ value: string;
29
+ }[];
30
+ inputParams?: {
18
31
  key: string;
19
32
  value: any;
20
33
  type: "string" | "integer" | "date";
21
34
  defaultValue: any;
22
35
  selector: string;
23
36
  }[];
24
- graphQlQuery: string;
25
- aggregationModel: string;
26
- aggregationPipeline: string;
27
- resultAsObject: boolean;
28
- replace: boolean;
29
- random: boolean;
30
- fetchData: boolean;
31
- lastResult: any;
32
- lastResultJSON: string;
37
+ graphQlQuery?: string;
38
+ aggregationModel?: string;
39
+ aggregationPipeline?: string;
40
+ resultAsObject?: boolean;
41
+ replace?: boolean;
42
+ random?: boolean;
43
+ fetchData?: boolean;
44
+ lastResult?: any;
45
+ lastResultJSON?: string;
33
46
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tolinax/ayoune-interfaces",
3
- "version": "2024.4.25",
3
+ "version": "2024.4.27",
4
4
  "description": "Houses TypeScript interfaces for aYOUne",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",