@tolinax/ayoune-interfaces 2025.16.1 → 2025.16.2

package/interfaces/CostBucketResult.d.ts

@@ -0,0 +1,40 @@
+import { IDefaultFields } from "./IDefaultFields";
+export interface ICostBucketResult extends IDefaultFields {
+    lab: boolean;
+    environment: "production" | "lab" | "all";
+    _customerID: ObjectId;
+    _research: ObjectId;
+    date?: Date;
+    numKeywords?: number;
+    bid?: number;
+    maxCPC?: number;
+    avgCPC?: number;
+    minCPC?: number;
+    maxCost?: number;
+    avgCost?: number;
+    minCost?: number;
+    maxClicks?: number;
+    avgClicks?: number;
+    minClicks?: number;
+    maxImpressions?: number;
+    avgImpressions?: number;
+    minImpressions?: number;
+    maxConversions?: number;
+    avgConversions?: number;
+    minConversions?: number;
+    maxConversionRate?: number;
+    avgConversionRate?: number;
+    minConversionRate?: number;
+    maxCTR?: number;
+    avgCTR?: number;
+    minCTR?: number;
+    maxCPA?: number;
+    avgCPA?: number;
+    minCPA?: number;
+    maxAds?: number;
+    breakPointMin?: number;
+    breakPointMax?: number;
+    breakPointAvg?: number;
+    market?: string;
+    category?: string;
+}

package/interfaces/CostBucketResult.js

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

package/interfaces/IAdvertiserDomainKPI.d.ts

@@ -0,0 +1,9 @@
+import { IDefaultFields } from "./IDefaultFields";
+export interface IAdvertiserWeeklyDomainKPI extends IDefaultFields {
+    _customerID?: ObjectId;
+    domain?: string;
+    device?: string;
+    iab?: string;
+    iabLabel?: string;
+    benchmark?: string;
+}

package/interfaces/IAdvertiserDomainKPI.js

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

package/interfaces/IGeoIPLocation.d.ts

@@ -0,0 +1,17 @@
+export interface IGeoIPLocationTracking {
+    ip?: string;
+    range?: number[];
+    country?: string;
+    region?: string;
+    eu?: string;
+    timezone?: string;
+    city?: string;
+    ll?: number[];
+    metro?: number;
+    area?: number;
+    device?: string;
+    query?: string;
+    url?: string;
+    fingerprint?: string;
+    referrer?: string;
+}

package/interfaces/IGeoIPLocation.js

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

package/interfaces/IGoogleAdsAccount.d.ts

@@ -0,0 +1,19 @@
+import { IDefaultFields } from "./IDefaultFields";
+export interface IGoogleAdsAccount extends IDefaultFields {
+    name: string;
+    meta: {
+        active: boolean;
+        oAuthLink: string;
+        keyGenLink: string;
+    };
+    googleAdsClient: {
+        client_id: string;
+        client_secret: string;
+        developer_token: string;
+    };
+    customerClient: {
+        customer_id: string;
+        login_customer_id: string;
+        refresh_token: string;
+    };
+}

package/interfaces/IGoogleAdsAccount.js

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

package/interfaces/IIABCategoryMappings.d.ts

@@ -0,0 +1,11 @@
+import { IDefaultFields } from "./IDefaultFields";
+interface Mapping {
+    IABCategory: string;
+    label: string;
+}
+export interface IIABCategoryMapping extends IDefaultFields {
+    _id?: ObjectId;
+    _customerID?: ObjectId;
+    mappings: Mapping[];
+}
+export {};

package/interfaces/IIABCategoryMappings.js

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

package/interfaces/IIndustryBudget.d.ts

@@ -0,0 +1,22 @@
+import { IDefaultFields } from "./IDefaultFields";
+export interface IMarketBudget extends IDefaultFields {
+    lab: boolean;
+    environment: "production" | "lab" | "all";
+    _industry: ObjectId;
+    _company: ObjectId;
+    date: Date;
+    domain?: string;
+    host?: string;
+    ads: number;
+    avgPosition: number;
+    avgMonthlySearches: number;
+    avgCPC: number;
+    impressions: number;
+    deliveryRate: number;
+    termsCount: number;
+    terms: any[];
+    budget: number;
+    market?: string;
+    region?: string;
+    device?: string;
+}

package/interfaces/IIndustryBudget.js

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

package/interfaces/IIndustryKPIs.d.ts

@@ -0,0 +1,20 @@
+import { IDefaultFields } from "./IDefaultFields";
+export interface IIndustryKPI extends IDefaultFields {
+    lab: boolean;
+    environment: "production" | "lab" | "all";
+    _industry: ObjectId;
+    date: Date;
+    host?: string;
+    ads: number;
+    avgPosition: number;
+    avgMonthlySearches: number;
+    avgCPC: number;
+    impressions: number;
+    deliveryRate: number;
+    termsCount: number;
+    terms: any[];
+    budget: number;
+    market?: string;
+    region?: string;
+    device?: string;
+}

package/interfaces/IIndustryKPIs.js

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

package/interfaces/IModel.d.ts

@@ -0,0 +1,3 @@
+export interface IModel<T extends Document> {
+    dataTable?(query?: any, options?: any): Promise<any>;
+}

package/interfaces/IModel.js

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

package/interfaces/IStreamPart.js

@@ -0,0 +1 @@
+"use strict";

package/interfaces/IValues.d.ts

@@ -0,0 +1,3 @@
+export interface ILabels {
+    [key: string]: string;
+}

package/interfaces/IValues.js

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

package/interfaces/IaYOUneAdvertisementLocation.d.ts

@@ -0,0 +1,12 @@
+import { IDefaultFields } from "./IDefaultFields";
+import { IAddress } from "./IAddress";
+export interface IaYOUneAdvertisementLocation extends IDefaultFields {
+    _customerID?: ObjectId;
+    name?: string;
+    note?: string;
+    address?: IAddress;
+    prioritizeOwnAds?: boolean;
+    ratio?: number;
+    mediaTypes?: string[];
+    locale?: string;
+}

package/interfaces/IaYOUneAdvertisementLocation.js

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

package/interfaces/IaYOUneDomainMeta.d.ts

@@ -0,0 +1,6 @@
+import { IDefaultFields } from "./IDefaultFields";
+export interface IAdvertiserDomainMeta extends IDefaultFields {
+    _customerID?: ObjectId;
+    domain?: string;
+    category?: string;
+}

package/interfaces/IaYOUneDomainMeta.js

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

package/interfaces/IaYOUneKeywordKPIs.d.ts

@@ -0,0 +1,162 @@
+import { IDefaultFields } from "./IDefaultFields";
+declare enum Environment {
+    production = "production",
+    lab = "lab",
+    all = "all"
+}
+declare enum Device {
+    mobile = "mobile",
+    desktop = "desktop"
+}
+interface LastChecks {
+    mobile?: Date;
+    desktop?: Date;
+    priceRange?: Date;
+    price?: Date;
+    trends?: Date;
+    keyword_planner?: Date;
+}
+interface Cost {
+    createdAt?: Date;
+    bid?: number;
+    grp?: number;
+    cpc?: number;
+    cpd?: number;
+    cost?: number;
+    impressions?: number;
+    ctr?: number;
+}
+interface Annotation {
+    name?: string;
+    concept_group: {
+        name?: string;
+        type?: string;
+    };
+}
+interface MonthlySearch {
+    year?: string;
+    month?: string;
+    monthly_searches?: number;
+}
+interface Related {
+    _keyword?: string;
+}
+interface Question {
+    _keyword?: string;
+}
+interface Preposition {
+    modifier?: string;
+    _keyword?: string;
+}
+interface Comparison {
+    modifier?: string;
+    _keyword?: string;
+}
+interface Alphabetical {
+    modifier?: string;
+    _keyword?: string;
+}
+interface Translation {
+    locale?: string;
+    _keyword?: string;
+}
+interface IABCategory {
+    _id?: string;
+    label?: string;
+    parent?: string;
+    count?: number;
+}
+export interface IaYOUneKeyword extends IDefaultFields {
+    lab?: boolean;
+    environment?: Environment;
+    keyword: string;
+    niceName?: string;
+    locale: string;
+    last_checks?: LastChecks;
+    _lastDevice?: string;
+    lastDeviceKind?: Device;
+    next_check?: Date;
+    needsCheck?: boolean;
+    needsManualIndustrySelection?: boolean;
+    active?: boolean;
+    isQuestion?: boolean;
+    isMisspelling?: boolean;
+    isMisspellingOf?: string;
+    correctSpelling?: string;
+    keywordPlanner?: boolean;
+    hasAds?: boolean;
+    hasAdsOnMobile?: boolean;
+    hasAdsOnTablet?: boolean;
+    hasAdsOnDesktop?: boolean;
+    hasPLA?: boolean;
+    hasPLAOnMobile?: boolean;
+    hasPLAOnTablet?: boolean;
+    hasPLAOnDesktop?: boolean;
+    hasSEA?: boolean;
+    hasSEAOnMobile?: boolean;
+    hasSEAOnTablet?: boolean;
+    hasSEAOnDesktop?: boolean;
+    hasFlights?: boolean;
+    hasFlightsOnMobile?: boolean;
+    hasFlightsOnTablet?: boolean;
+    hasFlightsOnDesktop?: boolean;
+    hasBooking?: boolean;
+    hasBookingOnMobile?: boolean;
+    hasBookingOnTablet?: boolean;
+    hasBookingOnDesktop?: boolean;
+    hasKnowledgeGraph?: boolean;
+    hasKnowledgeGraphsOnMobile?: boolean;
+    hasKnowledgeGraphsOnTablet?: boolean;
+    hasKnowledgeGraphOnDesktop?: boolean;
+    hasBooks?: boolean;
+    hasVideos?: boolean;
+    hasCosts?: boolean;
+    hasTrends?: boolean;
+    avgGrp?: number;
+    avgCpc?: number;
+    avgCpcGoogle?: number;
+    avgCpcIndustry?: number;
+    avgCpd?: number;
+    avgCpdIndustry?: number;
+    avgCost?: number;
+    avgCostIndustry?: number;
+    avgCtr?: number;
+    avgCtrIndustry?: number;
+    avgImpressions?: number;
+    avgImpressionsIndustry?: number;
+    breakPointMin?: number;
+    breakPointMax?: number;
+    breakPointAvg?: number;
+    costs?: Cost[];
+    domainAssumptions?: any[];
+    domainProves?: any[];
+    interest?: number;
+    competition?: string;
+    competitionIndex?: number;
+    participants?: number;
+    competitiveness?: number;
+    avgMonthlySearches?: number;
+    lowTopOfPageBidMicros?: number;
+    highTopOfPageBidMicros?: number;
+    annotations?: Annotation[];
+    monthlySearches?: MonthlySearch[];
+    type?: string;
+    kind?: string;
+    origin?: string;
+    industry?: ObjectId;
+    subIndustry?: ObjectId;
+    related?: Related[];
+    synonyms?: Related[];
+    questions?: Question[];
+    prepositions?: Preposition[];
+    comparisons?: Comparison[];
+    alphabeticals?: Alphabetical[];
+    translations?: Translation[];
+    serps?: string[];
+    IABCategories?: IABCategory[];
+    mainCategory?: string;
+    mainCategoryLabel?: string;
+    subCategory?: string;
+    subCategoryLabel?: string;
+}
+export {};

package/interfaces/IaYOUneKeywordKPIs.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var Environment;
+(function (Environment) {
+    Environment["production"] = "production";
+    Environment["lab"] = "lab";
+    Environment["all"] = "all";
+})(Environment || (Environment = {}));
+var Device;
+(function (Device) {
+    Device["mobile"] = "mobile";
+    Device["desktop"] = "desktop";
+})(Device || (Device = {}));

package/interfaces/IaYOUneSocialAccounts.d.ts

@@ -0,0 +1,19 @@
+import { IDefaultFields } from "./IDefaultFields";
+export interface IaYOUneSocialAccount extends IDefaultFields {
+    name: string;
+    meta: {
+        active: boolean;
+        oAuthLink: string;
+        keyGenLink: string;
+    };
+    googleAdsClient: {
+        client_id: string;
+        client_secret: string;
+        developer_token: string;
+    };
+    customerClient: {
+        customer_id: string;
+        login_customer_id: string;
+        refresh_token: string;
+    };
+}

package/interfaces/IaYOUneSocialAccounts.js

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

package/interfaces/IaYOUneTrackingParams.d.ts

@@ -1,3 +1,9 @@
+export interface IaYOUneEvent {
+    category?: string;
+    action?: string;
+    label?: string;
+    value?: string;
+}
 export interface IaYOUneTrackingParams {
     ayoune_ac?: string;
     ayoune_ucd?: string;
@@ -30,7 +36,7 @@ export interface IaYOUneTrackingParams {
     ayoune_feedback?: string;
     ayoune_rating?: string;
     ayoune_mail_link_id?: string;
-    ayoune_event?: string;
+    ayoune_event?: string | IaYOUneEvent;
     ayoune_agency?: string;
     ayoune_partner?: string;
     ayoune_aff?: string;

package/interfaces//303/216CostBucketResult.d.ts

@@ -0,0 +1,40 @@
+import { IDefaultFields } from "./IDefaultFields";
+export interface ICostBucketResult extends IDefaultFields {
+    lab: boolean;
+    environment: "production" | "lab" | "all";
+    _customerID: ObjectId;
+    _research: ObjectId;
+    date?: Date;
+    numKeywords?: number;
+    bid?: number;
+    maxCPC?: number;
+    avgCPC?: number;
+    minCPC?: number;
+    maxCost?: number;
+    avgCost?: number;
+    minCost?: number;
+    maxClicks?: number;
+    avgClicks?: number;
+    minClicks?: number;
+    maxImpressions?: number;
+    avgImpressions?: number;
+    minImpressions?: number;
+    maxConversions?: number;
+    avgConversions?: number;
+    minConversions?: number;
+    maxConversionRate?: number;
+    avgConversionRate?: number;
+    minConversionRate?: number;
+    maxCTR?: number;
+    avgCTR?: number;
+    minCTR?: number;
+    maxCPA?: number;
+    avgCPA?: number;
+    minCPA?: number;
+    maxAds?: number;
+    breakPointMin?: number;
+    breakPointMax?: number;
+    breakPointAvg?: number;
+    market?: string;
+    category?: string;
+}

package/interfaces//303/216CostBucketResult.js

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

package/package.json

@@ -1,106 +1,106 @@
-{
-  "name": "@tolinax/ayoune-interfaces",
-  "version": "2025.16.1",
-  "description": "Houses TypeScript interfaces for aYOUne",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "build": "npx tsc",
-    "copy-package": "cpx package.json dist",
-    "prerelease": "npm run build",
-    "release": "release-it --ci",
-    "postrelease": "npm run release-package",
-    "prerelease-package": "npm run copy-package",
-    "release-package": "cd dist && npm publish",
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/tolinax/ayoune-interfaces.git"
-  },
-  "keywords": [
-    "typescript",
-    "interfaces"
-  ],
-  "author": "tolinax",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/tolinax/ayoune-interfaces/issues"
-  },
-  "homepage": "https://github.com/tolinax/ayoune-interfaces#readme",
-  "release-it": {
-    "git": {
-      "changelog": "git log --pretty=format:\"* %s (%h)\" ${from}...${to}",
-      "requireCleanWorkingDir": false,
-      "addUntrackedFiles": true,
-      "commit": true,
-      "push": true,
-      "commitMessage": "ci(chore): release v${version}\n\n${changelog}",
-      "tag": true
-    },
-    "npm": {
-      "publish": false
-    },
-    "plugins": {
-      "@release-it/conventional-changelog": {
-        "preset": {
-          "name": "conventionalcommits",
-          "header": "# Changelog",
-          "types": [
-            {
-              "type": "feat",
-              "section": "Features"
-            },
-            {
-              "type": "fix",
-              "section": "Bug Fixes"
-            },
-            {
-              "type": "chore",
-              "section": "Chores"
-            },
-            {
-              "type": "docs",
-              "section": "Docs"
-            },
-            {
-              "type": "style",
-              "section": "Style changes"
-            },
-            {
-              "type": "refactor",
-              "section": "Refactorings"
-            },
-            {
-              "type": "perf",
-              "section": "Performance"
-            },
-            {
-              "type": "test",
-              "section": "Tests"
-            },
-            {
-              "type": "ci",
-              "section": "Continous Integration"
-            },
-            {
-              "type": "build",
-              "section": "Build Process"
-            },
-            {
-              "type": "infra",
-              "section": "Infrastructure"
-            }
-          ]
-        },
-        "infile": "CHANGELOG.md"
-      }
-    }
-  },
-  "dependencies": {},
-  "devDependencies": {
-    "@release-it/conventional-changelog": "^5.0.0",
-    "cpx": "^1.5.0",
-    "typescript": "^5.3.3"
-  }
-}
+{
+  "name": "@tolinax/ayoune-interfaces",
+  "version": "2025.16.2",
+  "description": "Houses TypeScript interfaces for aYOUne",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "npx tsc",
+    "copy-package": "cpx package.json dist",
+    "prerelease": "npm run build",
+    "release": "release-it --ci",
+    "postrelease": "npm run release-package",
+    "prerelease-package": "npm run copy-package",
+    "release-package": "cd dist && npm publish",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tolinax/ayoune-interfaces.git"
+  },
+  "keywords": [
+    "typescript",
+    "interfaces"
+  ],
+  "author": "tolinax",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/tolinax/ayoune-interfaces/issues"
+  },
+  "homepage": "https://github.com/tolinax/ayoune-interfaces#readme",
+  "release-it": {
+    "git": {
+      "changelog": "git log --pretty=format:\"* %s (%h)\" ${from}...${to}",
+      "requireCleanWorkingDir": false,
+      "addUntrackedFiles": true,
+      "commit": true,
+      "push": true,
+      "commitMessage": "ci(chore): release v${version}\n\n${changelog}",
+      "tag": true
+    },
+    "npm": {
+      "publish": false
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": {
+          "name": "conventionalcommits",
+          "header": "# Changelog",
+          "types": [
+            {
+              "type": "feat",
+              "section": "Features"
+            },
+            {
+              "type": "fix",
+              "section": "Bug Fixes"
+            },
+            {
+              "type": "chore",
+              "section": "Chores"
+            },
+            {
+              "type": "docs",
+              "section": "Docs"
+            },
+            {
+              "type": "style",
+              "section": "Style changes"
+            },
+            {
+              "type": "refactor",
+              "section": "Refactorings"
+            },
+            {
+              "type": "perf",
+              "section": "Performance"
+            },
+            {
+              "type": "test",
+              "section": "Tests"
+            },
+            {
+              "type": "ci",
+              "section": "Continous Integration"
+            },
+            {
+              "type": "build",
+              "section": "Build Process"
+            },
+            {
+              "type": "infra",
+              "section": "Infrastructure"
+            }
+          ]
+        },
+        "infile": "CHANGELOG.md"
+      }
+    }
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "@release-it/conventional-changelog": "^5.0.0",
+    "cpx": "^1.5.0",
+    "typescript": "^5.3.3"
+  }
+}