@tolinax/ayoune-interfaces 2024.2.0 → 2024.2.1

package/src/interfaces/IaYOUneCustomer.ts

@@ -5,16 +5,16 @@ import { IaYOUnePackage } from "./IaYOUnePackage";
 import { IaYOUneProduct } from "./IaYOUneProduct";
 
 interface IUser {
-  user: string | IaYOUneUser;
-  role: string | IaYOUneRole;
+  user: ObjectId | IaYOUneUser;
+  role: ObjectId | IaYOUneRole;
   customRights: ICustomRight[];
   active: boolean;
   hidden: boolean;
 }
 
 interface IPackage {
-  package: string | IaYOUnePackage;
-  product: string | IaYOUneProduct;
+  package: ObjectId | IaYOUnePackage;
+  product: ObjectId | IaYOUneProduct;
   costs?: number;
   name?: string;
   date_booked?: Date;
@@ -22,7 +22,7 @@ interface IPackage {
 
 interface ICustomRight {
   right: string;
-  product: string | IaYOUneProduct;
+  product: ObjectId | IaYOUneProduct;
   valid_from?: Date;
   valid_till?: Date;
 }
@@ -45,11 +45,11 @@ interface IRouting {
 }
 
 export interface IaYOUneCustomer extends IDefaultFields {
-  reseller?: string;
-  agency?: string;
+  reseller?: ObjectId;
+  agency?: ObjectId;
   _ayouneid?: string;
   freeAccount?: boolean;
-  _consumerID?: string;
+  _consumerID?: ObjectId;
   salutation?: string;
   company?: string;
   legal_form?: string;

package/src/interfaces/IaYOUneCustomerStat.ts

@@ -13,7 +13,7 @@ export interface IEntry {
 }
 
 export interface IaYOUneCustomerStat extends IDefaultFields {
-  ayouneCustomer: string;
+  ayouneCustomer: ObjectId;
   size?: number;
   firstEntryDate?: Date;
   endEntryDate?: Date;

package/src/interfaces/IaYOUneCustomerTodo.ts

@@ -1,7 +1,7 @@
 import { IDefaultFields } from "./IDefaultFields";
 
 export interface IaYOUneCustomerTodo extends IDefaultFields {
-  _customerID: string;
+  _customerID: ObjectId;
   name?: string;
   link?: string;
   done?: boolean;

package/src/interfaces/IaYOUneDomain.ts

@@ -1,13 +1,13 @@
 import { IDefaultFields } from "./IDefaultFields";
-import { IIABCategory } from "./IIABCategory";
+import { IIABCategoryEntry } from "./IIABCategoryEntry";
 
 export interface IaYOUneDomain extends IDefaultFields {
   domain?: string;
   locale?: string;
   numAds?: number;
-  IABCategories?: IIABCategory[];
-  mainCategory?: string;
+  IABCategories?: IIABCategoryEntry[];
+  mainCategory?: ObjectId;
   mainCategoryLabel?: string;
-  subCategory?: string;
+  subCategory?: ObjectId;
   subCategoryLabel?: string;
 }

package/src/interfaces/IaYOUneDomainsWithCategory.ts

@@ -1,13 +1,13 @@
 import { IDefaultFields } from "./IDefaultFields";
-import { IIABCategory } from "./IIABCategory";
+import { IIABCategoryEntry } from "./IIABCategoryEntry";
 
 export interface IaYOUneDomainsWithCategory extends IDefaultFields {
-  IABCategories: IIABCategory[];
   domain?: string;
   locale?: string;
-  mainCategory?: string;
-  mainCategoryLabel?: string;
   numAds?: number;
-  subCategory?: string;
+  IABCategories: IIABCategoryEntry[];
+  mainCategory?: ObjectId;
+  mainCategoryLabel?: string;
+  subCategory?: ObjectId;
   subCategoryLabel?: string;
 }

package/src/interfaces/IaYOUneInvite.ts

@@ -9,9 +9,9 @@ export interface IaYOUneInvite extends IDefaultFields {
   status: string;
   sent: boolean;
   sentOn?: Date;
-  sourceUser: string;
-  sourceCustomer: string;
-  targetCustomer: string;
+  sourceUser: ObjectId;
+  sourceCustomer: ObjectId;
+  targetCustomer: ObjectId;
   inviteEmail?: string;
   inviteEmailAP?: string;
   password_set: boolean;

package/src/interfaces/IaYOUneKeywordPreparation.ts

@@ -1,7 +1,7 @@
 import { IDefaultFields } from "./IDefaultFields";
 
 export interface IaYOUneKeywordPreparation extends IDefaultFields {
-  _keyword: string;
+  _keyword: ObjectId;
   keyword: string;
   locale: string;
   avgMonthlySearches: number;

package/src/interfaces/IaYOUneLog.ts

@@ -1,7 +1,7 @@
 import { IDefaultFields } from "./IDefaultFields";
 
 export interface IaYOUneLog extends IDefaultFields {
-  _customerID: string;
+  _customerID: ObjectId;
   timestamp?: Date;
   level?: string;
   message?: string;

package/src/interfaces/IaYOUneMenu.ts

@@ -4,6 +4,6 @@ import { IaYOUneMenuItem } from "./IaYOUneMenuItem";
 export interface IaYOUneMenu extends IDefaultFields {
   title: string;
   identifier: string;
-  menu: string[] | IaYOUneMenuItem[];
-  products: string[];
+  menu: ObjectId[] | IaYOUneMenuItem[];
+  products: ObjectId[];
 }

package/src/interfaces/IaYOUneMenuItem.ts

@@ -1,5 +1,5 @@
 export interface IaYOUneMenuItem {
-  _state?: string;
+  _state?: ObjectId;
   title?: string;
   hideTitle?: boolean;
   type?: string;

package/src/interfaces/IaYOUneMenuTemplate.ts

@@ -9,7 +9,7 @@ export interface IFunction {
   functionParams?: object;
 }
 
-interface IGroup {
+export interface IGroup {
   groupName?: string;
   groupPath?: string;
   groupIcon?: string;

package/src/interfaces/IaYOUnePackage.ts

@@ -2,7 +2,7 @@ import { IDefaultFields } from "./IDefaultFields";
 
 export interface IaYOUnePackage extends IDefaultFields {
   name?: string;
-  product?: string;
+  product?: ObjectId;
   modules?: any[];
   mailsPerMonth?: number;
   dbStorage?: number;

package/src/interfaces/IaYOUneParsingProfile.ts

@@ -1,3 +1,4 @@
+import { Types } from "mongoose";
 import { IDefaultFields } from "./IDefaultFields";
 
 export interface IElement extends IDefaultFields {
@@ -12,7 +13,7 @@ export interface IElement extends IDefaultFields {
   postFnArgs?: string;
   mandatory?: boolean;
   resolveToBoolean?: boolean;
-  subElements?: IElement[];
+  subElements?: Types.Array<IElement>;
 }
 
 export interface IBlock extends IDefaultFields {
@@ -22,8 +23,8 @@ export interface IBlock extends IDefaultFields {
   controlColor?: string;
   removeElements?: boolean;
   throwError?: boolean;
-  elements?: IElement[];
-  subBlocks?: IBlock[];
+  elements?: Types.Array<IElement>;
+  subBlocks?: Types.Array<IBlock>;
 }
 
 export interface IaYOUneParsingProfile extends IDefaultFields {
@@ -34,6 +35,6 @@ export interface IaYOUneParsingProfile extends IDefaultFields {
   countries?: string[];
   isMaster?: boolean;
   testSerpId?: string;
-  blocks?: IBlock[];
-  elements?: IElement[];
+  blocks?: Types.Array<IBlock>;
+  elements?: Types.Array<IElement>;
 }

package/src/interfaces/IaYOUnePipeline.ts

@@ -22,12 +22,12 @@ interface IJob {
   active?: boolean;
   allowedToFail?: boolean;
   entity?: string;
-  entityId?: string;
+  entityId?: ObjectId;
   namespace?: string;
   inputParams?: IInputParam[];
   capabilitiesNeeded?: string[];
   fulfillment?: string;
-  _middleware?: string;
+  _middleware?: ObjectId;
   action?: string;
   input?: any;
   output?: any;
@@ -50,11 +50,11 @@ interface IStage {
 
 export interface IaYOUnePipeline extends IDefaultFields {
   name?: string;
-  _customerID: string;
-  _clientID?: string[];
-  _subID?: string[];
-  _consumerID?: string;
-  _user?: string;
+  _customerID: ObjectId;
+  _clientID?: ObjectId[];
+  _subID?: ObjectId[];
+  _consumerID?: ObjectId;
+  _user?: ObjectId;
   multiInstance?: boolean;
   triggerType?: string;
   trigger?: string;

package/src/interfaces/IaYOUneProxy.ts

@@ -17,9 +17,9 @@ export interface IProvider {
 }
 
 export interface IaYOUneProxy extends IDefaultFields {
-  _customerID: string;
-  _clientID?: string[];
-  _subID?: string[];
+  _customerID: ObjectId;
+  _clientID?: ObjectId[];
+  _subID?: ObjectId[];
   binding: string;
   environments: string[];
   name: string;

package/src/interfaces/IaYOUneProxyUser.ts

@@ -2,23 +2,23 @@ import { IDefaultFields } from "./IDefaultFields";
 import { IDemographics } from "./IDemographics";
 import { IaYOUneProxyAddress } from "./IaYOUneProxyAddress";
 
-export interface IProxyUserSegment {
-  _segment: string;
+export interface IaYOUneProxyUserSegment {
+  _segment: ObjectId;
   weight: number;
 }
 
-interface IKeywordEntry {
+export interface IaYOUneProxyUserKeyword {
   keyword?: string;
-  _keyword?: string;
+  _keyword?: ObjectId;
   locale?: string;
 }
 
-export interface IProxyUserAccount {
+export interface IaYOUneProxyUserAccount {
   username: string;
   password: string;
 }
 
-export interface IActiveTimes {
+export interface IaYOUneProxyUserActiveTimes {
   morning: number;
   noon: number;
   afternoon: number;
@@ -26,7 +26,7 @@ export interface IActiveTimes {
   night: number;
 }
 
-export interface ICookie {
+export interface IaYOUneProxyUserDeviceCookie {
   name?: string;
   value?: string;
   domain?: string;
@@ -42,8 +42,8 @@ export interface ICookie {
   sourcePort?: number;
 }
 
-export interface IDevice {
-  _device?: string;
+export interface IaYOUneProxyUserDevice {
+  _device?: ObjectId;
   kindOfDevice: "mobile" | "tablet" | "desktop" | "watch";
   lockedUntil?: Date;
   active?: boolean;
@@ -51,7 +51,7 @@ export interface IDevice {
   userAgent: string;
   lastCrawl?: Date;
   lastUrl?: string;
-  cookies: ICookie[];
+  cookies: IaYOUneProxyUserDeviceCookie[];
   loc: {
     type: "Point";
     coordinates: number[];
@@ -60,27 +60,27 @@ export interface IDevice {
 }
 
 export interface IaYOUneProxyUser extends IDefaultFields {
-  _proxy?: string;
+  _proxy?: ObjectId;
   binding: string;
   environments: string[];
   lockedUntil?: Date;
   lastCrawl?: Date;
   lastUrl?: string;
   crawlCount: number;
-  segments: IProxyUserSegment[];
-  keywords: IKeywordEntry[];
+  segments: IaYOUneProxyUserSegment[];
+  keywords: IaYOUneProxyUserKeyword[];
   username?: string;
   firstName?: string;
   lastName?: string;
   accounts: {
-    google: IProxyUserAccount;
-    bing: IProxyUserAccount;
-    yandex: IProxyUserAccount;
-    amazon: IProxyUserAccount;
+    google: IaYOUneProxyUserAccount;
+    bing: IaYOUneProxyUserAccount;
+    yandex: IaYOUneProxyUserAccount;
+    amazon: IaYOUneProxyUserAccount;
   };
   phoneNumber?: string;
   demographic: IDemographics;
-  activeTimes: IActiveTimes;
-  devices: IDevice[];
+  activeTimes: IaYOUneProxyUserActiveTimes;
+  devices: IaYOUneProxyUserDevice[];
   address: IaYOUneProxyAddress;
 }

package/src/interfaces/IaYOUneRegisterCrawl.ts

@@ -1,7 +1,7 @@
 import { IDefaultFields } from "./IDefaultFields";
 
 export interface IaYOUneRegisterCrawl extends IDefaultFields {
-  _company?: string;
+  _company?: ObjectId;
   state?: string;
   registerNoticeId?: number;
   registrar?: string;

package/src/interfaces/IaYOUneReport.ts

@@ -1,18 +1,13 @@
 import { IDefaultFields } from "./IDefaultFields";
 import { IRecipient } from "./IRecipient";
-
-export interface IReportEntry {
-  file: string;
-  fileName: string;
-  ts: Date;
-}
+import { IReportEntry } from "./IReportEntry";
 
 export interface IaYOUneReport extends IDefaultFields {
   name: string;
   reportdata: object;
   reportDataId: string;
-  owner: string;
-  template: string;
+  owner: ObjectId;
+  template: ObjectId;
   sendToConsumer: boolean;
   scheduled: boolean;
   scheduledInterval: number;

package/src/interfaces/IaYOUneReseller.ts

@@ -33,8 +33,8 @@ export interface IResellerSetting {
 }
 
 export interface IaYOUneReseller extends IDefaultFields {
-  _customerID?: string;
-  _consumerID?: string;
+  _customerID?: ObjectId;
+  _consumerID?: ObjectId;
   logo?: string;
   icon?: string;
   settings?: IResellerSetting;

package/src/interfaces/IaYOUneRole.ts

@@ -10,7 +10,7 @@ interface IRestrictions {
 }
 
 export interface IaYOUneRole extends IDefaultFields {
-  _customerID?: string;
+  _customerID?: ObjectId;
   rights?: any[];
   name?: string;
   description?: string;

package/src/interfaces/IaYOUneState.ts

@@ -23,7 +23,7 @@ interface IParam {
 }
 
 interface IRelatedState {
-  state: string;
+  state: ObjectId;
   params: IParam[];
 }
 
@@ -60,7 +60,7 @@ export interface IaYOUneState extends IDefaultFields {
   isSubFunction?: boolean;
   isSubSubFunction?: boolean;
   isRightOfState?: boolean;
-  demoId?: string;
+  demoId?: ObjectId;
   modelName?: string;
   dashboard_categories?: any[];
   summary?: string;

package/src/interfaces/IaYOUneStateLog.ts

@@ -1,8 +1,8 @@
 import { IDefaultFields } from "./IDefaultFields";
 
 export interface IaYOUneStateLog extends IDefaultFields {
-  _customerID: string;
-  _userID?: string;
+  _customerID: ObjectId;
+  _userID?: ObjectId;
   name?: string;
   company?: string;
   username?: string;

package/src/interfaces/IaYOUneStatesCustomerOverride.ts

@@ -6,9 +6,9 @@ interface NoContent {
 }
 
 export interface IaYOUneStatesCustomerOverride extends IDefaultFields {
-  _customerID: string;
-  _clientID: string[];
-  _subID: string[];
+  _customerID: ObjectId;
+  _clientID: ObjectId[];
+  _subID: ObjectId[];
   title?: string;
   iconConfig?: any[];
   name?: string;

package/src/interfaces/IaYOUneStatesUserOverride.ts

@@ -2,10 +2,10 @@ import { IDefaultFields } from "./IDefaultFields";
 import { IaYOUneStatesViewConfig } from "./IaYOUneStatesViewConfig";
 
 export interface IaYOUneStatesUserOverride extends IDefaultFields {
-  _customerID: string;
-  _clientID: string[];
-  _subID: string[];
-  _userID?: string;
+  _customerID: ObjectId;
+  _clientID: ObjectId[];
+  _subID: ObjectId[];
+  _userID?: ObjectId;
   title?: string;
   viewConfig: IaYOUneStatesViewConfig;
 }

package/src/interfaces/IaYOUneStatesViewConfig.ts

@@ -42,7 +42,7 @@ interface InfoBlock {
 
 interface Widget {
   viewConditions: IaYOUneStatesViewConfigViewConditions[];
-  widget: string;
+  widget: ObjectId;
   detailIdField: string;
 }
 
@@ -88,7 +88,7 @@ interface Card {
   dragEnabled: boolean;
   resizeEnabled: boolean;
   compactEnabled: boolean;
-  widget: string;
+  widget: ObjectId;
 }
 
 interface Rows {

package/src/interfaces/IaYOUneStatesViewConfigContent.ts

@@ -4,5 +4,5 @@ export interface IaYOUneStatesViewConfigContent {
   contentType: "html" | "iframe" | "widget";
   iFrameUrl?: string;
   html?: string;
-  widget?: string;
+  widget?: ObjectId;
 }

package/src/interfaces/IaYOUneTranslation.ts

@@ -4,6 +4,6 @@ export interface IaYOUneTranslation extends IDefaultFields {
   key: string;
   value: string;
   locale: string;
-  user: string;
+  user: ObjectId;
   products: string[];
 }

package/src/interfaces/IaYOUneUser.ts

@@ -1,3 +1,4 @@
+import { Types } from "mongoose";
 import { IDefaultFields } from "./IDefaultFields";
 
 export interface IaYOUneUser extends IDefaultFields {
@@ -43,7 +44,7 @@ export interface IaYOUneUser extends IDefaultFields {
   city?: string;
   dob?: Date;
   type?: string;
-  role?: string;
+  role?: ObjectId;
   interfaceRole?: string;
   userRights?: any[];
   approved?: boolean;
@@ -52,7 +53,7 @@ export interface IaYOUneUser extends IDefaultFields {
   nationality?: string;
   entering_date?: Date;
   group?: string;
-  websites?: any[];
+  websites?: Types.Array<any>;
   IBAN?: string;
   SWIFT?: string;
   BANK?: string;
@@ -62,24 +63,24 @@ export interface IaYOUneUser extends IDefaultFields {
   active?: boolean;
   archive?: boolean;
   doi?: boolean;
-  customer?: string;
-  _customerID?: string;
-  parent?: string;
+  customer?: ObjectId;
+  _customerID?: ObjectId;
+  parent?: ObjectId;
   isTerminalUser?: boolean;
   isTerminalAdmin?: boolean;
   isAdmin?: boolean;
   isAgencyUser?: boolean;
   isResellerUser?: boolean;
-  agency?: string;
-  reseller?: string;
+  agency?: ObjectId;
+  reseller?: ObjectId;
   loginAttempts?: number;
   lockUntil?: number;
   last_login?: Date;
   labuser?: boolean;
   tester?: boolean;
-  recoveryCodes?: any[];
+  recoveryCodes?: Types.Array<any>;
   su?: any;
-  resellerOptions?: unknown;
+  resellerOptions?: any;
   avatar?: string;
   isLocked?: boolean;
   reasons: any;

package/src/interfaces/IaYOUneUserRight.ts

@@ -7,9 +7,9 @@ export interface ICustomRight {
 }
 
 export interface IaYOUneUserRight extends IDefaultFields {
-  _customerID: string;
-  _userID: string;
-  _product: string;
-  roles: string[];
+  _customerID: ObjectId;
+  _userID: ObjectId;
+  _product: ObjectId;
+  roles: ObjectId[];
   customRights: ICustomRight[];
 }

package/src/interfaces/IaYOUneWidget.ts

@@ -1,12 +1,12 @@
 import { IDefaultFields } from "./IDefaultFields";
 
-export interface IWidgetFieldLink {
+export interface ILink {
   state?: string;
   params?: { param?: string; value?: string }[];
   query?: { param?: string; value?: string }[];
 }
 
-export interface IWidgetField {
+export interface IField {
   field?: string;
   label?: string;
   formatter?:
@@ -17,7 +17,7 @@ export interface IWidgetField {
     | "dateTime"
     | "time"
     | "link";
-  link?: IWidgetFieldLink;
+  link?: ILink;
 }
 
 export interface ISeries {
@@ -25,8 +25,8 @@ export interface ISeries {
   dataSource: {
     model?: string;
     query?: string;
-    fields?: IWidgetField[];
-    link?: IWidgetFieldLink;
+    fields?: IField[];
+    link?: ILink;
     limit?: boolean;
     limitAmount?: number;
     group?: boolean;

package/src/interfaces/index.ts

@@ -373,6 +373,7 @@ export * from "./IMiddleware";
 export * from "./IMilestone";
 export * from "./IMobileApp";
 export * from "./IMobileDevice";
+export * from "./IModel";
 export * from "./IMouseover";
 export * from "./IName";
 export * from "./index";
@@ -610,3 +611,10 @@ export * from "./IWizard";
 export * from "./IWorkCenter";
 export * from "./IWorkLog";
 export * from "./IXingContact";
+export * from "./IPimSelectionsSettings";
+export * from "./IAgent";
+export * from "./IRecipient";
+export * from "./IReportEntry";
+export { ILighthouseResults } from "./ILighthouseResults";
+export { IBrandBiddingInfo } from "./IBrandBiddingInfo";
+export { IImageEntry } from "./IImageEntry";

package/src/types.d.ts

@@ -0,0 +1,6 @@
+import { Types } from "mongoose";
+
+declare global {
+  // eslint-disable-next-line no-unused-vars
+  type ObjectId = string | Types.ObjectId | any;
+}

package/tsconfig.json

@@ -4,13 +4,14 @@
     "module": "commonjs",
     "declaration": true,
     "outDir": "./dist",
-    "strict": true
+    "strict": true,
+    "skipLibCheck": true
   },
   "include": [
     "src/**/*.ts"
   ],
   "exclude": [
-    "node_modules",
+    "node_modules/**/*.d.ts",
     "**/*.spec.ts"
   ]
 }

package/.eslintrc.js

@@ -1,9 +0,0 @@
-// eslint-disable-next-line no-undef
-module.exports = {
-  extends: ["eslint:recommended"],
-  parser: "@typescript-eslint/parser",
-  parserOptions: { ecmaVersion: 2020, sourceType: "module" },
-  rules: {
-    "sort-keys": ["error", "asc", { natural: true }],
-  },
-};