@tolinax/ayoune-interfaces 2024.2.0 → 2024.2.1

package/src/interfaces/IQuote.ts

@@ -2,19 +2,19 @@ import { IDefaultFields } from "./IDefaultFields";
 import { ITTS } from "./ITTS";
 
 export interface IQuote extends IDefaultFields {
-  _customerID: string;
-  _clientID?: string[];
-  _subID?: string[];
+  _customerID: ObjectId;
+  _clientID?: ObjectId[];
+  _subID?: ObjectId[];
   author?: string;
   quote?: string;
   popularity?: number;
   tags?: any[];
   lang?: string;
   category?: string;
-  videoId?: string;
+  videoId?: ObjectId;
   videoName?: string;
   videoUrl?: string;
-  imageId?: string;
+  imageId?: ObjectId;
   imageName?: string;
   imageUrl?: string;
   tts: ITTS;

package/src/interfaces/IRating.ts

@@ -1,16 +1,16 @@
 import { IDefaultFields } from "./IDefaultFields";
 
 export interface IRating extends IDefaultFields {
-  _customerID: string;
-  _clientID?: string[];
-  _subID?: string[];
-  _consumerID?: string;
-  product?: string;
+  _customerID: ObjectId;
+  _clientID?: ObjectId[];
+  _subID?: ObjectId[];
+  _consumerID?: ObjectId;
+  product?: ObjectId;
   interestchannels?: any[];
   ratingID?: string;
   res?: object;
   type?: string;
-
+  created?: Date;
   stars?: string;
   rating?: string;
   done?: boolean;

package/src/interfaces/IRatingTemplate.ts

@@ -1,9 +1,9 @@
 import { IDefaultFields } from "./IDefaultFields";
 
 export interface IRatingTemplate extends IDefaultFields {
-  _customerID: string;
-  _clientID: string[];
-  _subID: string[];
+  _customerID: ObjectId;
+  _clientID: ObjectId[];
+  _subID: ObjectId[];
   shortID: string;
   name?: string;
   slug?: string;

package/src/interfaces/IReaction.ts

@@ -1,5 +1,5 @@
 export interface IReaction {
-  _user: string;
+  _user: ObjectId;
   reaction: string;
   char: string;
 }

package/src/interfaces/IRecommendation.ts

@@ -1,13 +1,13 @@
 import { IDefaultFields } from "./IDefaultFields";
 
 export interface IRecommendation extends IDefaultFields {
-  _customerID: string;
-  _clientID: string[];
-  _subID: string[];
-  _task: string;
+  _customerID: ObjectId;
+  _clientID: ObjectId[];
+  _subID: ObjectId[];
+  _task: ObjectId;
   identifier: string;
   mainField: string;
-  foreignID?: string;
+  foreignID?: ObjectId;
   category: string;
   subCategory: string;
   groupKey: string;
@@ -16,10 +16,10 @@ export interface IRecommendation extends IDefaultFields {
   tags: string[];
   acknowledged: boolean;
   acknowledgedAt?: Date;
-  acknowledgedBy: string;
+  acknowledgedBy: ObjectId;
   resolved: boolean;
   type: string;
-  metrics: string[];
+  metrics: ObjectId[];
   originView: {
     state: string;
     stateParams: object;

package/src/interfaces/IRecommendationTemplate.ts

@@ -23,13 +23,13 @@ export interface IRecommendationTemplate extends IDefaultFields {
   modelName?: string;
   feature?: string;
   repeaterDataSource: {
-    dataSource: string;
+    dataSource: ObjectId;
     customers: Array<{
-      _customerID?: string;
+      _customerID?: ObjectId;
       company?: string;
     }>;
   };
-  dataSources: string[];
+  dataSources: ObjectId[];
   inputData?: object;
   recommendations: Array<{
     label?: string;
@@ -37,7 +37,7 @@ export interface IRecommendationTemplate extends IDefaultFields {
     descriptions: Array<{
       lang?: string;
       text?: string;
-      aiPrompt?: string;
+      aiPrompt?: ObjectId;
     }>;
     mainField?: string;
     subCategory?: string;

package/src/interfaces/IReminder.ts

@@ -1,19 +1,19 @@
 import { IDefaultFields } from "./IDefaultFields";
 
 export interface IReminder extends IDefaultFields {
-  _customerID: string;
-  _clientID?: string[];
-  _subID?: string[];
-  _consumerID?: string;
-  _receiver?: string;
-  user?: string;
+  _customerID: ObjectId;
+  _clientID?: ObjectId[];
+  _subID?: ObjectId[];
+  _consumerID?: ObjectId;
+  _receiver?: ObjectId;
+  user?: ObjectId;
   username?: string;
   agent?: string;
   reminderstep?: number;
   nbr?: number;
   koi?: string;
-  invoice?: string;
-  depositinvoice?: string;
+  invoice?: ObjectId;
+  depositinvoice?: ObjectId;
   text_pre?: string;
   text_post?: string;
   pricedate?: Date;
@@ -21,7 +21,7 @@ export interface IReminder extends IDefaultFields {
   due?: Date;
   note?: string;
   status?: string;
-
+  created?: Date;
   sum?: number;
   fee?: number;
   total?: number;

package/src/interfaces/IReport.ts

@@ -1,23 +1,18 @@
 import { IDefaultFields } from "./IDefaultFields";
 import { IRecipient } from "./IRecipient";
-
-export interface IReports {
-  file: string;
-  fileName: string;
-  ts: Date;
-}
+import { IReportEntry } from "./IReportEntry";
 
 export interface IReport extends IDefaultFields {
-  _customerID: string;
-  _consumerID?: string;
-  _clientID?: string[];
-  _subID?: string[];
+  _customerID: ObjectId;
+  _consumerID?: ObjectId;
+  _clientID?: ObjectId[];
+  _subID?: ObjectId[];
   name: string;
   active: boolean;
   reportdata?: any;
   reportDataId: string;
-  owner?: string;
-  template?: string;
+  owner?: ObjectId;
+  template?: ObjectId;
   sendToConsumer: boolean;
   scheduled: boolean;
   scheduledInterval: number;
@@ -52,5 +47,5 @@ export interface IReport extends IDefaultFields {
   nextRun?: Date;
   lastRun?: Date;
   recipients: IRecipient[];
-  reports: IReports[];
+  reports: IReportEntry[];
 }

package/src/interfaces/IReportEntry.ts

@@ -0,0 +1,5 @@
+export interface IReportEntry {
+  file: ObjectId;
+  fileName: string;
+  ts: Date;
+}

package/src/interfaces/IReportTemplate.ts

@@ -1,14 +1,14 @@
 import { IDefaultFields } from "./IDefaultFields";
 
-export interface IReportRequirement {
+export interface IReportTemplateRequirement {
   field?: string;
   value?: any;
 }
 
 export interface IReportTemplate extends IDefaultFields {
-  _clientID?: string[];
-  _subID?: string[];
-  _customerID: string;
+  _clientID?: ObjectId[];
+  _subID?: ObjectId[];
+  _customerID: ObjectId;
   name?: string;
   reportdata?: any;
   category?: string;
@@ -25,6 +25,6 @@ export interface IReportTemplate extends IDefaultFields {
   autoPrint?: boolean;
   showParams?: boolean;
   limitToUsers?: boolean;
-  users?: string[];
-  requirements?: IReportRequirement[];
+  users?: ObjectId[];
+  requirements?: IReportTemplateRequirement[];
 }

package/src/interfaces/IRepository.ts

@@ -1,8 +1,8 @@
 export interface IRepository {
   provider: "bitbucket" | "github" | "gitlab";
-  _webHook?: string;
-  _check?: string;
-  _service?: string;
+  _webHook?: ObjectId;
+  _check?: ObjectId;
+  _service?: ObjectId;
   repoSlug: string;
   showOnDashboard: boolean;
   repoURL: string;

package/src/interfaces/IRequirement.ts

@@ -1,6 +1,6 @@
 import { IDefaultFields } from "./IDefaultFields";
 
-interface IStep {
+interface IRequirementStep {
   name?: string;
   kind?: string;
   field?: string;
@@ -15,13 +15,13 @@ interface IStep {
 }
 
 export interface IRequirement extends IDefaultFields {
-  _customerID: string;
-  _clientID?: string[];
-  _subID?: string[];
+  _customerID: ObjectId;
+  _clientID?: ObjectId[];
+  _subID?: ObjectId[];
   name?: string;
   description?: string;
   types?: string[];
   kinds?: string[];
   models?: string[];
-  steps?: IStep[];
+  steps?: IRequirementStep[];
 }

package/src/interfaces/IResearchBudget.ts

@@ -3,10 +3,10 @@ import { IDefaultFields } from "./IDefaultFields";
 export interface IResearchBudget extends IDefaultFields {
   lab: boolean;
   environment: "production" | "lab" | "all";
-  _customerID: string;
-  _industry: string;
-  _company: string;
-  _research: string;
+  _customerID: ObjectId;
+  _industry: ObjectId;
+  _company: ObjectId;
+  _research: ObjectId;
   date?: Date;
   domain?: string;
   host?: string;

package/src/interfaces/IRetrospective.ts

@@ -3,25 +3,25 @@ import { IDefaultFields } from "./IDefaultFields";
 export interface IRetrospectiveTask {
   subject: string;
   note: string;
-  task: string;
+  task: ObjectId;
   type: string;
   user: string;
   priority: string;
 }
 
 export interface IRetrospective extends IDefaultFields {
-  _customerID: string;
-  _clientID: string[];
-  _subID: string[];
-  _consumerID: string;
-  _project: string;
-  _milestone: string;
-  _component: string;
-  _epic: string;
-  _sprint: string;
-  _story: string;
-  user: string;
-  team: string;
+  _customerID: ObjectId;
+  _clientID: ObjectId[];
+  _subID: ObjectId[];
+  _consumerID: ObjectId;
+  _project: ObjectId;
+  _milestone: ObjectId;
+  _component: ObjectId;
+  _epic: ObjectId;
+  _sprint: ObjectId;
+  _story: ObjectId;
+  user: ObjectId;
+  team: ObjectId;
   name: string;
   showAttendees: boolean;
   archive: boolean;

package/src/interfaces/IRewardLog.ts

@@ -1,10 +1,10 @@
 import { IDefaultFields } from "./IDefaultFields";
 
 export interface IRewardLog extends IDefaultFields {
-  _customerID: string;
-  _clientID?: string[];
-  _subID?: string[];
-  user?: string;
+  _customerID: ObjectId;
+  _clientID?: ObjectId[];
+  _subID?: ObjectId[];
+  user?: ObjectId;
   type?: string;
   value?: number;
 }

package/src/interfaces/IRewardRule.ts

@@ -1,9 +1,9 @@
 import { IDefaultFields } from "./IDefaultFields";
 
 export interface IRewardRule extends IDefaultFields {
-  _customerID: string;
-  _clientID?: string[];
-  _subID?: string[];
+  _customerID: ObjectId;
+  _clientID?: ObjectId[];
+  _subID?: ObjectId[];
   rule?: string;
   value?: number;
 }

package/src/interfaces/IRolloutEnvironment.ts

@@ -3,7 +3,7 @@ import { IRolloutStrategy } from "./IRolloutStrategy";
 
 export interface IRolloutEnvironment extends Document {
   _id: boolean;
-  _environment: string;
+  _environment: ObjectId;
   enabled: boolean;
   name: string;
   lastSeenAt: Date;

package/src/interfaces/IRolloutStrategy.ts

@@ -1,8 +1,9 @@
+import { Document } from "mongoose";
 import { IVariant } from "./IVariant";
 
-export interface IRolloutStrategy {
+export interface IRolloutStrategy extends Document {
   _id: boolean;
-  _strategy: string;
+  _strategy: ObjectId;
   constraints: any[];
   disabled: boolean;
   name: string;

package/src/interfaces/IRunningPipeline.ts

@@ -1,6 +1,6 @@
 import { IDefaultFields } from "./IDefaultFields";
 
-interface IWarning {
+interface IRunningPipelineWarning {
   title: string;
   message: string;
   details: string;
@@ -8,33 +8,33 @@ interface IWarning {
   link: string;
   obj: object;
   code: number;
-  stage: string;
-  job: string;
+  stage: ObjectId;
+  job: ObjectId;
 }
 
-interface IPError {
+interface IRunningPipelineError {
   title: string;
   message: string;
   details: string;
   ts: Date;
   obj: object;
   code: number;
-  stage: string;
-  job: string;
+  stage: ObjectId;
+  job: ObjectId;
 }
 
-interface ILog {
+interface IRunningPipelineLog {
   title: string;
   message?: string;
   details?: string;
   ts: Date;
   obj: object;
   code?: number;
-  stage?: string;
-  job?: string;
+  stage?: ObjectId;
+  job?: ObjectId;
 }
 
-interface IStats {
+interface IRunningPipelineStats {
   totalStages: number;
   stagesDone: number;
   stagesOpen: number;
@@ -45,20 +45,20 @@ interface IStats {
   jobProgress: number;
 }
 
-interface IJob {
+interface IRunningPipelineJob {
   name: string;
   state: string;
   running: boolean;
   active: boolean;
   allowedToFail: boolean;
   entity: string;
-  entityId: string;
+  entityId: ObjectId;
   namespace: string;
   inputParams: Array<any>;
   capabilitiesNeeded: Array<string>;
   fulfillment: string;
   action: string;
-  middleware: string;
+  middleware: ObjectId;
   input: any;
   output: any;
   outputAs: string;
@@ -69,7 +69,7 @@ interface IJob {
   mergeData: boolean;
 }
 
-interface IStage {
+interface IRunningPipelineStage {
   name: string;
   active: boolean;
   input: any;
@@ -77,32 +77,32 @@ interface IStage {
   status: string;
   done: boolean;
   mergeData: boolean;
-  jobs: IJob[];
+  jobs: IRunningPipelineJob[];
 }
 
 export interface IRunningPipeline extends IDefaultFields {
   name?: string;
   hash?: string;
   done: boolean;
-  _customerID: string;
-  _clientID: string[];
-  _subID: string[];
-  _consumerID?: string;
-  _user?: string;
-  _configuration?: string;
-  _offer?: string;
-  _project?: string;
-  _assignment?: string;
-  _invoice?: string;
+  _customerID: ObjectId;
+  _clientID: ObjectId[];
+  _subID: ObjectId[];
+  _consumerID?: ObjectId;
+  _user?: ObjectId;
+  _configuration?: ObjectId;
+  _offer?: ObjectId;
+  _project?: ObjectId;
+  _assignment?: ObjectId;
+  _invoice?: ObjectId;
   multiInstance: boolean;
   trigger?: string;
   uniqueIdentifier?: string;
   entities: any[];
-  warnings: IWarning[];
-  pErrors: IPError[];
-  logs: ILog[];
-  stats: IStats;
-  stages: IStage[];
+  warnings: IRunningPipelineWarning[];
+  pErrors: IRunningPipelineError[];
+  logs: IRunningPipelineLog[];
+  stats: IRunningPipelineStats;
+  stages: IRunningPipelineStage[];
   protected: boolean;
   active: boolean;
 }

package/src/interfaces/ISERPHtml.ts

@@ -2,17 +2,17 @@ import { IDefaultFields } from "./IDefaultFields";
 
 export interface ISERPHtml extends IDefaultFields {
   archived: boolean;
-  _customerID?: string;
-  _clientID?: string[];
-  _subID?: string[];
-  _keyword?: string;
-  _serp?: string;
+  _customerID?: ObjectId;
+  _clientID?: ObjectId[];
+  _subID?: ObjectId[];
+  _keyword?: ObjectId;
+  _serp?: ObjectId;
   term: string;
   locale: string;
   device: string;
-  _device?: string;
-  _proxy?: string;
-  _user?: string;
+  _device?: ObjectId;
+  _proxy?: ObjectId;
+  _user?: ObjectId;
   meta: Record<string, unknown>;
   html: string;
   gcs: {

package/src/interfaces/ISLA.ts

@@ -11,10 +11,10 @@ interface ICategory {
 }
 
 export interface ISLA extends IDefaultFields {
-  _customerID: string;
-  _consumerID?: string;
-  _clientID?: string[];
-  _subID?: string[];
+  _customerID: ObjectId;
+  _consumerID?: ObjectId;
+  _clientID?: ObjectId[];
+  _subID?: ObjectId[];
   name?: string;
   blocker?: ICategory;
   heavy?: ICategory;

package/src/interfaces/ISMSLog.ts

@@ -1,10 +1,10 @@
 import { IDefaultFields } from "./IDefaultFields";
 
 export interface ISMSLog extends IDefaultFields {
-  _customerID: string;
-  _clientID?: string[];
-  _subID?: string[];
-  _consumerID?: string;
+  _customerID: ObjectId;
+  _clientID?: ObjectId[];
+  _subID?: ObjectId[];
+  _consumerID?: ObjectId;
   mbid?: string; // MessageBird Id
   twId?: string; // Twilio Id
   recipient?: string;

package/src/interfaces/ISMSTemplate.ts

@@ -1,11 +1,11 @@
 import { IDefaultFields } from "./IDefaultFields";
 
 export interface ISMSTemplate extends IDefaultFields {
-  _customerID: string;
-  _clientID?: string[];
-  _subID?: string[];
+  _customerID: ObjectId;
+  _clientID?: ObjectId[];
+  _subID?: ObjectId[];
   name?: string;
-  group?: string;
+  group?: ObjectId;
   content?: string;
   content_en?: string;
 }