@memberjunction/core-entities 2.106.0 → 2.108.0

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.
@@ -333,9 +333,11 @@ export declare const ActionSchema: z.ZodObject<{
333
333
  DriverClass: z.ZodNullable<z.ZodString>;
334
334
  ParentID: z.ZodNullable<z.ZodString>;
335
335
  IconClass: z.ZodNullable<z.ZodString>;
336
+ DefaultCompactPromptID: z.ZodNullable<z.ZodString>;
336
337
  Category: z.ZodNullable<z.ZodString>;
337
338
  CodeApprovedByUser: z.ZodNullable<z.ZodString>;
338
339
  Parent: z.ZodNullable<z.ZodString>;
340
+ DefaultCompactPrompt: z.ZodNullable<z.ZodString>;
339
341
  RootParentID: z.ZodNullable<z.ZodString>;
340
342
  }, "strip", z.ZodTypeAny, {
341
343
  ID?: string;
@@ -362,8 +364,10 @@ export declare const ActionSchema: z.ZodObject<{
362
364
  ForceCodeGeneration?: boolean;
363
365
  DriverClass?: string;
364
366
  IconClass?: string;
367
+ DefaultCompactPromptID?: string;
365
368
  Category?: string;
366
369
  CodeApprovedByUser?: string;
370
+ DefaultCompactPrompt?: string;
367
371
  }, {
368
372
  ID?: string;
369
373
  __mj_CreatedAt?: Date;
@@ -389,8 +393,10 @@ export declare const ActionSchema: z.ZodObject<{
389
393
  ForceCodeGeneration?: boolean;
390
394
  DriverClass?: string;
391
395
  IconClass?: string;
396
+ DefaultCompactPromptID?: string;
392
397
  Category?: string;
393
398
  CodeApprovedByUser?: string;
399
+ DefaultCompactPrompt?: string;
394
400
  }>;
395
401
  export type ActionEntityType = z.infer<typeof ActionSchema>;
396
402
  /**
@@ -440,8 +446,14 @@ export declare const AIAgentActionSchema: z.ZodObject<{
440
446
  __mj_UpdatedAt: z.ZodDate;
441
447
  MinExecutionsPerRun: z.ZodNullable<z.ZodNumber>;
442
448
  MaxExecutionsPerRun: z.ZodNullable<z.ZodNumber>;
449
+ ResultExpirationTurns: z.ZodNullable<z.ZodNumber>;
450
+ ResultExpirationMode: z.ZodUnion<[z.ZodLiteral<"Compact">, z.ZodLiteral<"None">, z.ZodLiteral<"Remove">]>;
451
+ CompactMode: z.ZodNullable<z.ZodUnion<[z.ZodLiteral<"AI Summary">, z.ZodLiteral<"First N Chars">]>>;
452
+ CompactLength: z.ZodNullable<z.ZodNumber>;
453
+ CompactPromptID: z.ZodNullable<z.ZodString>;
443
454
  Agent: z.ZodNullable<z.ZodString>;
444
455
  Action: z.ZodNullable<z.ZodString>;
456
+ CompactPrompt: z.ZodNullable<z.ZodString>;
445
457
  }, "strip", z.ZodTypeAny, {
446
458
  ID?: string;
447
459
  ActionID?: string;
@@ -452,7 +464,13 @@ export declare const AIAgentActionSchema: z.ZodObject<{
452
464
  AgentID?: string;
453
465
  MinExecutionsPerRun?: number;
454
466
  MaxExecutionsPerRun?: number;
467
+ ResultExpirationTurns?: number;
468
+ ResultExpirationMode?: "Compact" | "None" | "Remove";
469
+ CompactMode?: "AI Summary" | "First N Chars";
470
+ CompactLength?: number;
471
+ CompactPromptID?: string;
455
472
  Agent?: string;
473
+ CompactPrompt?: string;
456
474
  }, {
457
475
  ID?: string;
458
476
  ActionID?: string;
@@ -463,7 +481,13 @@ export declare const AIAgentActionSchema: z.ZodObject<{
463
481
  AgentID?: string;
464
482
  MinExecutionsPerRun?: number;
465
483
  MaxExecutionsPerRun?: number;
484
+ ResultExpirationTurns?: number;
485
+ ResultExpirationMode?: "Compact" | "None" | "Remove";
486
+ CompactMode?: "AI Summary" | "First N Chars";
487
+ CompactLength?: number;
488
+ CompactPromptID?: string;
466
489
  Agent?: string;
490
+ CompactPrompt?: string;
467
491
  }>;
468
492
  export type AIAgentActionEntityType = z.infer<typeof AIAgentActionSchema>;
469
493
  /**
@@ -696,6 +720,7 @@ export declare const AIAgentSchema: z.ZodObject<{
696
720
  ChatHandlingOption: z.ZodNullable<z.ZodUnion<[z.ZodLiteral<"Failed">, z.ZodLiteral<"Retry">, z.ZodLiteral<"Success">]>>;
697
721
  DefaultArtifactTypeID: z.ZodNullable<z.ZodString>;
698
722
  OwnerUserID: z.ZodString;
723
+ InvocationMode: z.ZodUnion<[z.ZodLiteral<"Any">, z.ZodLiteral<"Sub-Agent">, z.ZodLiteral<"Top-Level">]>;
699
724
  Parent: z.ZodNullable<z.ZodString>;
700
725
  ContextCompressionPrompt: z.ZodNullable<z.ZodString>;
701
726
  Type: z.ZodNullable<z.ZodString>;
@@ -745,6 +770,7 @@ export declare const AIAgentSchema: z.ZodObject<{
745
770
  ChatHandlingOption?: "Failed" | "Retry" | "Success";
746
771
  DefaultArtifactTypeID?: string;
747
772
  OwnerUserID?: string;
773
+ InvocationMode?: "Any" | "Sub-Agent" | "Top-Level";
748
774
  ContextCompressionPrompt?: string;
749
775
  DefaultArtifactType?: string;
750
776
  OwnerUser?: string;
@@ -791,6 +817,7 @@ export declare const AIAgentSchema: z.ZodObject<{
791
817
  ChatHandlingOption?: "Failed" | "Retry" | "Success";
792
818
  DefaultArtifactTypeID?: string;
793
819
  OwnerUserID?: string;
820
+ InvocationMode?: "Any" | "Sub-Agent" | "Top-Level";
794
821
  ContextCompressionPrompt?: string;
795
822
  DefaultArtifactType?: string;
796
823
  OwnerUser?: string;
@@ -1051,12 +1078,12 @@ export declare const AIPromptSchema: z.ZodObject<{
1051
1078
  MinPowerRank?: number;
1052
1079
  SelectionStrategy?: "ByPower" | "Default" | "Specific";
1053
1080
  PowerPreference?: "Balanced" | "Highest" | "Lowest";
1054
- ParallelizationMode?: "ModelSpecific" | "ConfigParam" | "None" | "StaticCount";
1081
+ ParallelizationMode?: "None" | "ModelSpecific" | "ConfigParam" | "StaticCount";
1055
1082
  ParallelCount?: number;
1056
1083
  ParallelConfigParam?: string;
1057
1084
  OutputType?: "string" | "number" | "boolean" | "object" | "date";
1058
1085
  OutputExample?: string;
1059
- ValidationBehavior?: "Warn" | "None" | "Strict";
1086
+ ValidationBehavior?: "None" | "Warn" | "Strict";
1060
1087
  MaxRetries?: number;
1061
1088
  RetryDelayMS?: number;
1062
1089
  RetryStrategy?: "Exponential" | "Fixed" | "Linear";
@@ -1081,7 +1108,7 @@ export declare const AIPromptSchema: z.ZodObject<{
1081
1108
  StopSequences?: string;
1082
1109
  IncludeLogProbs?: boolean;
1083
1110
  TopLogProbs?: number;
1084
- FailoverStrategy?: "PowerRank" | "None" | "NextBestModel" | "SameModelDifferentVendor";
1111
+ FailoverStrategy?: "None" | "PowerRank" | "NextBestModel" | "SameModelDifferentVendor";
1085
1112
  FailoverMaxAttempts?: number;
1086
1113
  FailoverDelaySeconds?: number;
1087
1114
  FailoverModelStrategy?: "PreferDifferentModel" | "PreferSameModel" | "RequireSameModel";
@@ -1109,12 +1136,12 @@ export declare const AIPromptSchema: z.ZodObject<{
1109
1136
  MinPowerRank?: number;
1110
1137
  SelectionStrategy?: "ByPower" | "Default" | "Specific";
1111
1138
  PowerPreference?: "Balanced" | "Highest" | "Lowest";
1112
- ParallelizationMode?: "ModelSpecific" | "ConfigParam" | "None" | "StaticCount";
1139
+ ParallelizationMode?: "None" | "ModelSpecific" | "ConfigParam" | "StaticCount";
1113
1140
  ParallelCount?: number;
1114
1141
  ParallelConfigParam?: string;
1115
1142
  OutputType?: "string" | "number" | "boolean" | "object" | "date";
1116
1143
  OutputExample?: string;
1117
- ValidationBehavior?: "Warn" | "None" | "Strict";
1144
+ ValidationBehavior?: "None" | "Warn" | "Strict";
1118
1145
  MaxRetries?: number;
1119
1146
  RetryDelayMS?: number;
1120
1147
  RetryStrategy?: "Exponential" | "Fixed" | "Linear";
@@ -1139,7 +1166,7 @@ export declare const AIPromptSchema: z.ZodObject<{
1139
1166
  StopSequences?: string;
1140
1167
  IncludeLogProbs?: boolean;
1141
1168
  TopLogProbs?: number;
1142
- FailoverStrategy?: "PowerRank" | "None" | "NextBestModel" | "SameModelDifferentVendor";
1169
+ FailoverStrategy?: "None" | "PowerRank" | "NextBestModel" | "SameModelDifferentVendor";
1143
1170
  FailoverMaxAttempts?: number;
1144
1171
  FailoverDelaySeconds?: number;
1145
1172
  FailoverModelStrategy?: "PreferDifferentModel" | "PreferSameModel" | "RequireSameModel";
@@ -2348,6 +2375,7 @@ export declare const ConversationDetailSchema: z.ZodObject<{
2348
2375
  ParentID: z.ZodNullable<z.ZodString>;
2349
2376
  AgentID: z.ZodNullable<z.ZodString>;
2350
2377
  Status: z.ZodUnion<[z.ZodLiteral<"Complete">, z.ZodLiteral<"Error">, z.ZodLiteral<"In-Progress">]>;
2378
+ SuggestedResponses: z.ZodNullable<z.ZodString>;
2351
2379
  Conversation: z.ZodNullable<z.ZodString>;
2352
2380
  User: z.ZodNullable<z.ZodString>;
2353
2381
  Artifact: z.ZodNullable<z.ZodString>;
@@ -2378,6 +2406,7 @@ export declare const ConversationDetailSchema: z.ZodObject<{
2378
2406
  ArtifactVersionID?: string;
2379
2407
  CompletionTime?: number;
2380
2408
  IsPinned?: boolean;
2409
+ SuggestedResponses?: string;
2381
2410
  Conversation?: string;
2382
2411
  Artifact?: string;
2383
2412
  }, {
@@ -2405,6 +2434,7 @@ export declare const ConversationDetailSchema: z.ZodObject<{
2405
2434
  ArtifactVersionID?: string;
2406
2435
  CompletionTime?: number;
2407
2436
  IsPinned?: boolean;
2437
+ SuggestedResponses?: string;
2408
2438
  Conversation?: string;
2409
2439
  Artifact?: string;
2410
2440
  }>;
@@ -4902,7 +4932,7 @@ export declare const AIAgentPromptSchema: z.ZodObject<{
4902
4932
  Prompt?: string;
4903
4933
  PromptID?: string;
4904
4934
  Purpose?: string;
4905
- ContextBehavior?: "Custom" | "Complete" | "None" | "InitialMessages" | "RecentMessages" | "Smart";
4935
+ ContextBehavior?: "Custom" | "None" | "Complete" | "InitialMessages" | "RecentMessages" | "Smart";
4906
4936
  ContextMessageCount?: number;
4907
4937
  }, {
4908
4938
  ID?: string;
@@ -4917,7 +4947,7 @@ export declare const AIAgentPromptSchema: z.ZodObject<{
4917
4947
  Prompt?: string;
4918
4948
  PromptID?: string;
4919
4949
  Purpose?: string;
4920
- ContextBehavior?: "Custom" | "Complete" | "None" | "InitialMessages" | "RecentMessages" | "Smart";
4950
+ ContextBehavior?: "Custom" | "None" | "Complete" | "InitialMessages" | "RecentMessages" | "Smart";
4921
4951
  ContextMessageCount?: number;
4922
4952
  }>;
4923
4953
  export type AIAgentPromptEntityType = z.infer<typeof AIAgentPromptSchema>;
@@ -4931,6 +4961,9 @@ export declare const AIAgentRelationshipSchema: z.ZodObject<{
4931
4961
  Status: z.ZodUnion<[z.ZodLiteral<"Active">, z.ZodLiteral<"Pending">, z.ZodLiteral<"Revoked">]>;
4932
4962
  __mj_CreatedAt: z.ZodDate;
4933
4963
  __mj_UpdatedAt: z.ZodDate;
4964
+ SubAgentOutputMapping: z.ZodNullable<z.ZodString>;
4965
+ SubAgentInputMapping: z.ZodNullable<z.ZodString>;
4966
+ SubAgentContextPaths: z.ZodNullable<z.ZodString>;
4934
4967
  Agent: z.ZodNullable<z.ZodString>;
4935
4968
  SubAgent: z.ZodNullable<z.ZodString>;
4936
4969
  }, "strip", z.ZodTypeAny, {
@@ -4941,6 +4974,9 @@ export declare const AIAgentRelationshipSchema: z.ZodObject<{
4941
4974
  AgentID?: string;
4942
4975
  Agent?: string;
4943
4976
  SubAgentID?: string;
4977
+ SubAgentOutputMapping?: string;
4978
+ SubAgentInputMapping?: string;
4979
+ SubAgentContextPaths?: string;
4944
4980
  SubAgent?: string;
4945
4981
  }, {
4946
4982
  ID?: string;
@@ -4950,6 +4986,9 @@ export declare const AIAgentRelationshipSchema: z.ZodObject<{
4950
4986
  AgentID?: string;
4951
4987
  Agent?: string;
4952
4988
  SubAgentID?: string;
4989
+ SubAgentOutputMapping?: string;
4990
+ SubAgentInputMapping?: string;
4991
+ SubAgentContextPaths?: string;
4953
4992
  SubAgent?: string;
4954
4993
  }>;
4955
4994
  export type AIAgentRelationshipEntityType = z.infer<typeof AIAgentRelationshipSchema>;
@@ -4993,7 +5032,7 @@ export declare const AIAgentRunStepSchema: z.ZodObject<{
4993
5032
  ErrorMessage?: string;
4994
5033
  AgentRunID?: string;
4995
5034
  StepNumber?: number;
4996
- StepType?: "Prompt" | "Actions" | "Chat" | "Decision" | "Sub-Agent" | "Validation";
5035
+ StepType?: "Sub-Agent" | "Prompt" | "Actions" | "Chat" | "Decision" | "Validation";
4997
5036
  StepName?: string;
4998
5037
  TargetID?: string;
4999
5038
  CompletedAt?: Date;
@@ -5017,7 +5056,7 @@ export declare const AIAgentRunStepSchema: z.ZodObject<{
5017
5056
  ErrorMessage?: string;
5018
5057
  AgentRunID?: string;
5019
5058
  StepNumber?: number;
5020
- StepType?: "Prompt" | "Actions" | "Chat" | "Decision" | "Sub-Agent" | "Validation";
5059
+ StepType?: "Sub-Agent" | "Prompt" | "Actions" | "Chat" | "Decision" | "Validation";
5021
5060
  StepName?: string;
5022
5061
  TargetID?: string;
5023
5062
  CompletedAt?: Date;
@@ -5073,6 +5112,7 @@ export declare const AIAgentRunSchema: z.ZodObject<{
5073
5112
  EffortLevel: z.ZodNullable<z.ZodNumber>;
5074
5113
  RunName: z.ZodNullable<z.ZodString>;
5075
5114
  Comments: z.ZodNullable<z.ZodString>;
5115
+ ScheduledJobRunID: z.ZodNullable<z.ZodString>;
5076
5116
  Agent: z.ZodNullable<z.ZodString>;
5077
5117
  Conversation: z.ZodNullable<z.ZodString>;
5078
5118
  User: z.ZodNullable<z.ZodString>;
@@ -5116,7 +5156,7 @@ export declare const AIAgentRunSchema: z.ZodObject<{
5116
5156
  ConversationDetailID?: string;
5117
5157
  ConversationDetailSequence?: number;
5118
5158
  CancellationReason?: "System" | "Timeout" | "User Request";
5119
- FinalStep?: "Failed" | "Retry" | "Success" | "Actions" | "Chat" | "Sub-Agent";
5159
+ FinalStep?: "Failed" | "Retry" | "Success" | "Sub-Agent" | "Actions" | "Chat";
5120
5160
  FinalPayload?: string;
5121
5161
  StartingPayload?: string;
5122
5162
  TotalPromptIterations?: number;
@@ -5125,6 +5165,7 @@ export declare const AIAgentRunSchema: z.ZodObject<{
5125
5165
  Data?: string;
5126
5166
  Verbose?: boolean;
5127
5167
  RunName?: string;
5168
+ ScheduledJobRunID?: string;
5128
5169
  OverrideModel?: string;
5129
5170
  OverrideVendor?: string;
5130
5171
  RootParentRunID?: string;
@@ -5164,7 +5205,7 @@ export declare const AIAgentRunSchema: z.ZodObject<{
5164
5205
  ConversationDetailID?: string;
5165
5206
  ConversationDetailSequence?: number;
5166
5207
  CancellationReason?: "System" | "Timeout" | "User Request";
5167
- FinalStep?: "Failed" | "Retry" | "Success" | "Actions" | "Chat" | "Sub-Agent";
5208
+ FinalStep?: "Failed" | "Retry" | "Success" | "Sub-Agent" | "Actions" | "Chat";
5168
5209
  FinalPayload?: string;
5169
5210
  StartingPayload?: string;
5170
5211
  TotalPromptIterations?: number;
@@ -5173,6 +5214,7 @@ export declare const AIAgentRunSchema: z.ZodObject<{
5173
5214
  Data?: string;
5174
5215
  Verbose?: boolean;
5175
5216
  RunName?: string;
5217
+ ScheduledJobRunID?: string;
5176
5218
  OverrideModel?: string;
5177
5219
  OverrideVendor?: string;
5178
5220
  RootParentRunID?: string;
@@ -5264,7 +5306,7 @@ export declare const AIAgentStepSchema: z.ZodObject<{
5264
5306
  PromptID?: string;
5265
5307
  SubAgentID?: string;
5266
5308
  SubAgent?: string;
5267
- StepType?: "Action" | "Prompt" | "Sub-Agent";
5309
+ StepType?: "Action" | "Sub-Agent" | "Prompt";
5268
5310
  StartingStep?: boolean;
5269
5311
  TimeoutSeconds?: number;
5270
5312
  RetryCount?: number;
@@ -5290,7 +5332,7 @@ export declare const AIAgentStepSchema: z.ZodObject<{
5290
5332
  PromptID?: string;
5291
5333
  SubAgentID?: string;
5292
5334
  SubAgent?: string;
5293
- StepType?: "Action" | "Prompt" | "Sub-Agent";
5335
+ StepType?: "Action" | "Sub-Agent" | "Prompt";
5294
5336
  StartingStep?: boolean;
5295
5337
  TimeoutSeconds?: number;
5296
5338
  RetryCount?: number;
@@ -5636,7 +5678,7 @@ export declare const AIPromptModelSchema: z.ZodObject<{
5636
5678
  Priority?: number;
5637
5679
  Model?: string;
5638
5680
  Vendor?: string;
5639
- ParallelizationMode?: "ConfigParam" | "None" | "StaticCount";
5681
+ ParallelizationMode?: "None" | "ConfigParam" | "StaticCount";
5640
5682
  ParallelCount?: number;
5641
5683
  ParallelConfigParam?: string;
5642
5684
  VendorID?: string;
@@ -5655,7 +5697,7 @@ export declare const AIPromptModelSchema: z.ZodObject<{
5655
5697
  Priority?: number;
5656
5698
  Model?: string;
5657
5699
  Vendor?: string;
5658
- ParallelizationMode?: "ConfigParam" | "None" | "StaticCount";
5700
+ ParallelizationMode?: "None" | "ConfigParam" | "StaticCount";
5659
5701
  ParallelCount?: number;
5660
5702
  ParallelConfigParam?: string;
5661
5703
  VendorID?: string;
@@ -6240,6 +6282,53 @@ export declare const CollectionArtifactSchema: z.ZodObject<{
6240
6282
  Collection?: string;
6241
6283
  }>;
6242
6284
  export type CollectionArtifactEntityType = z.infer<typeof CollectionArtifactSchema>;
6285
+ /**
6286
+ * zod schema definition for the entity MJ: Collection Permissions
6287
+ */
6288
+ export declare const CollectionPermissionSchema: z.ZodObject<{
6289
+ ID: z.ZodString;
6290
+ CollectionID: z.ZodString;
6291
+ UserID: z.ZodString;
6292
+ CanRead: z.ZodBoolean;
6293
+ CanShare: z.ZodBoolean;
6294
+ CanEdit: z.ZodBoolean;
6295
+ CanDelete: z.ZodBoolean;
6296
+ SharedByUserID: z.ZodNullable<z.ZodString>;
6297
+ __mj_CreatedAt: z.ZodDate;
6298
+ __mj_UpdatedAt: z.ZodDate;
6299
+ Collection: z.ZodString;
6300
+ User: z.ZodString;
6301
+ SharedByUser: z.ZodNullable<z.ZodString>;
6302
+ }, "strip", z.ZodTypeAny, {
6303
+ ID?: string;
6304
+ __mj_CreatedAt?: Date;
6305
+ __mj_UpdatedAt?: Date;
6306
+ UserID?: string;
6307
+ User?: string;
6308
+ CanRead?: boolean;
6309
+ CanDelete?: boolean;
6310
+ CanShare?: boolean;
6311
+ CanEdit?: boolean;
6312
+ CollectionID?: string;
6313
+ Collection?: string;
6314
+ SharedByUserID?: string;
6315
+ SharedByUser?: string;
6316
+ }, {
6317
+ ID?: string;
6318
+ __mj_CreatedAt?: Date;
6319
+ __mj_UpdatedAt?: Date;
6320
+ UserID?: string;
6321
+ User?: string;
6322
+ CanRead?: boolean;
6323
+ CanDelete?: boolean;
6324
+ CanShare?: boolean;
6325
+ CanEdit?: boolean;
6326
+ CollectionID?: string;
6327
+ Collection?: string;
6328
+ SharedByUserID?: string;
6329
+ SharedByUser?: string;
6330
+ }>;
6331
+ export type CollectionPermissionEntityType = z.infer<typeof CollectionPermissionSchema>;
6243
6332
  /**
6244
6333
  * zod schema definition for the entity MJ: Collections
6245
6334
  */
@@ -6254,8 +6343,10 @@ export declare const CollectionSchema: z.ZodObject<{
6254
6343
  Sequence: z.ZodNullable<z.ZodNumber>;
6255
6344
  __mj_CreatedAt: z.ZodDate;
6256
6345
  __mj_UpdatedAt: z.ZodDate;
6346
+ OwnerID: z.ZodNullable<z.ZodString>;
6257
6347
  Environment: z.ZodString;
6258
6348
  Parent: z.ZodNullable<z.ZodString>;
6349
+ Owner: z.ZodNullable<z.ZodString>;
6259
6350
  RootParentID: z.ZodNullable<z.ZodString>;
6260
6351
  }, "strip", z.ZodTypeAny, {
6261
6352
  ID?: string;
@@ -6271,6 +6362,8 @@ export declare const CollectionSchema: z.ZodObject<{
6271
6362
  EnvironmentID?: string;
6272
6363
  Environment?: string;
6273
6364
  Color?: string;
6365
+ OwnerID?: string;
6366
+ Owner?: string;
6274
6367
  }, {
6275
6368
  ID?: string;
6276
6369
  __mj_CreatedAt?: Date;
@@ -6285,6 +6378,8 @@ export declare const CollectionSchema: z.ZodObject<{
6285
6378
  EnvironmentID?: string;
6286
6379
  Environment?: string;
6287
6380
  Color?: string;
6381
+ OwnerID?: string;
6382
+ Owner?: string;
6288
6383
  }>;
6289
6384
  export type CollectionEntityType = z.infer<typeof CollectionSchema>;
6290
6385
  /**
@@ -6551,7 +6646,7 @@ export declare const ConversationArtifactPermissionSchema: z.ZodObject<{
6551
6646
  __mj_UpdatedAt?: Date;
6552
6647
  UserID?: string;
6553
6648
  ConversationArtifactID?: string;
6554
- AccessLevel?: "Edit" | "Owner" | "Read";
6649
+ AccessLevel?: "Owner" | "Edit" | "Read";
6555
6650
  ConversationArtifact?: string;
6556
6651
  }, {
6557
6652
  ID?: string;
@@ -6559,7 +6654,7 @@ export declare const ConversationArtifactPermissionSchema: z.ZodObject<{
6559
6654
  __mj_UpdatedAt?: Date;
6560
6655
  UserID?: string;
6561
6656
  ConversationArtifactID?: string;
6562
- AccessLevel?: "Edit" | "Owner" | "Read";
6657
+ AccessLevel?: "Owner" | "Edit" | "Read";
6563
6658
  ConversationArtifact?: string;
6564
6659
  }>;
6565
6660
  export type ConversationArtifactPermissionEntityType = z.infer<typeof ConversationArtifactPermissionSchema>;
@@ -7028,6 +7123,192 @@ export declare const ReportVersionSchema: z.ZodObject<{
7028
7123
  DataContextUpdated?: boolean;
7029
7124
  }>;
7030
7125
  export type ReportVersionEntityType = z.infer<typeof ReportVersionSchema>;
7126
+ /**
7127
+ * zod schema definition for the entity MJ: Scheduled Job Runs
7128
+ */
7129
+ export declare const ScheduledJobRunSchema: z.ZodObject<{
7130
+ ID: z.ZodString;
7131
+ ScheduledJobID: z.ZodString;
7132
+ StartedAt: z.ZodDate;
7133
+ CompletedAt: z.ZodNullable<z.ZodDate>;
7134
+ Status: z.ZodUnion<[z.ZodLiteral<"Cancelled">, z.ZodLiteral<"Completed">, z.ZodLiteral<"Failed">, z.ZodLiteral<"Running">, z.ZodLiteral<"Timeout">]>;
7135
+ Success: z.ZodNullable<z.ZodBoolean>;
7136
+ ErrorMessage: z.ZodNullable<z.ZodString>;
7137
+ Details: z.ZodNullable<z.ZodString>;
7138
+ ExecutedByUserID: z.ZodNullable<z.ZodString>;
7139
+ QueuedAt: z.ZodNullable<z.ZodDate>;
7140
+ __mj_CreatedAt: z.ZodDate;
7141
+ __mj_UpdatedAt: z.ZodDate;
7142
+ ScheduledJob: z.ZodString;
7143
+ ExecutedByUser: z.ZodNullable<z.ZodString>;
7144
+ }, "strip", z.ZodTypeAny, {
7145
+ ID?: string;
7146
+ __mj_CreatedAt?: Date;
7147
+ __mj_UpdatedAt?: Date;
7148
+ Status?: "Failed" | "Cancelled" | "Completed" | "Running" | "Timeout";
7149
+ StartedAt?: Date;
7150
+ Success?: boolean;
7151
+ Details?: string;
7152
+ ErrorMessage?: string;
7153
+ CompletedAt?: Date;
7154
+ ScheduledJobID?: string;
7155
+ ExecutedByUserID?: string;
7156
+ QueuedAt?: Date;
7157
+ ScheduledJob?: string;
7158
+ ExecutedByUser?: string;
7159
+ }, {
7160
+ ID?: string;
7161
+ __mj_CreatedAt?: Date;
7162
+ __mj_UpdatedAt?: Date;
7163
+ Status?: "Failed" | "Cancelled" | "Completed" | "Running" | "Timeout";
7164
+ StartedAt?: Date;
7165
+ Success?: boolean;
7166
+ Details?: string;
7167
+ ErrorMessage?: string;
7168
+ CompletedAt?: Date;
7169
+ ScheduledJobID?: string;
7170
+ ExecutedByUserID?: string;
7171
+ QueuedAt?: Date;
7172
+ ScheduledJob?: string;
7173
+ ExecutedByUser?: string;
7174
+ }>;
7175
+ export type ScheduledJobRunEntityType = z.infer<typeof ScheduledJobRunSchema>;
7176
+ /**
7177
+ * zod schema definition for the entity MJ: Scheduled Job Types
7178
+ */
7179
+ export declare const ScheduledJobTypeSchema: z.ZodObject<{
7180
+ ID: z.ZodString;
7181
+ Name: z.ZodString;
7182
+ Description: z.ZodNullable<z.ZodString>;
7183
+ DriverClass: z.ZodString;
7184
+ DomainRunEntity: z.ZodNullable<z.ZodString>;
7185
+ DomainRunEntityFKey: z.ZodNullable<z.ZodString>;
7186
+ NotificationsAvailable: z.ZodBoolean;
7187
+ __mj_CreatedAt: z.ZodDate;
7188
+ __mj_UpdatedAt: z.ZodDate;
7189
+ }, "strip", z.ZodTypeAny, {
7190
+ ID?: string;
7191
+ __mj_CreatedAt?: Date;
7192
+ __mj_UpdatedAt?: Date;
7193
+ Name?: string;
7194
+ Description?: string;
7195
+ DriverClass?: string;
7196
+ DomainRunEntity?: string;
7197
+ DomainRunEntityFKey?: string;
7198
+ NotificationsAvailable?: boolean;
7199
+ }, {
7200
+ ID?: string;
7201
+ __mj_CreatedAt?: Date;
7202
+ __mj_UpdatedAt?: Date;
7203
+ Name?: string;
7204
+ Description?: string;
7205
+ DriverClass?: string;
7206
+ DomainRunEntity?: string;
7207
+ DomainRunEntityFKey?: string;
7208
+ NotificationsAvailable?: boolean;
7209
+ }>;
7210
+ export type ScheduledJobTypeEntityType = z.infer<typeof ScheduledJobTypeSchema>;
7211
+ /**
7212
+ * zod schema definition for the entity MJ: Scheduled Jobs
7213
+ */
7214
+ export declare const ScheduledJobSchema: z.ZodObject<{
7215
+ ID: z.ZodString;
7216
+ JobTypeID: z.ZodString;
7217
+ Name: z.ZodString;
7218
+ Description: z.ZodNullable<z.ZodString>;
7219
+ CronExpression: z.ZodString;
7220
+ Timezone: z.ZodString;
7221
+ StartAt: z.ZodNullable<z.ZodDate>;
7222
+ EndAt: z.ZodNullable<z.ZodDate>;
7223
+ Status: z.ZodUnion<[z.ZodLiteral<"Active">, z.ZodLiteral<"Disabled">, z.ZodLiteral<"Expired">, z.ZodLiteral<"Paused">, z.ZodLiteral<"Pending">]>;
7224
+ Configuration: z.ZodNullable<z.ZodString>;
7225
+ OwnerUserID: z.ZodNullable<z.ZodString>;
7226
+ LastRunAt: z.ZodNullable<z.ZodDate>;
7227
+ NextRunAt: z.ZodNullable<z.ZodDate>;
7228
+ RunCount: z.ZodNumber;
7229
+ SuccessCount: z.ZodNumber;
7230
+ FailureCount: z.ZodNumber;
7231
+ NotifyOnSuccess: z.ZodBoolean;
7232
+ NotifyOnFailure: z.ZodBoolean;
7233
+ NotifyUserID: z.ZodNullable<z.ZodString>;
7234
+ NotifyViaEmail: z.ZodBoolean;
7235
+ NotifyViaInApp: z.ZodBoolean;
7236
+ LockToken: z.ZodNullable<z.ZodString>;
7237
+ LockedAt: z.ZodNullable<z.ZodDate>;
7238
+ LockedByInstance: z.ZodNullable<z.ZodString>;
7239
+ ExpectedCompletionAt: z.ZodNullable<z.ZodDate>;
7240
+ ConcurrencyMode: z.ZodUnion<[z.ZodLiteral<"Concurrent">, z.ZodLiteral<"Queue">, z.ZodLiteral<"Skip">]>;
7241
+ __mj_CreatedAt: z.ZodDate;
7242
+ __mj_UpdatedAt: z.ZodDate;
7243
+ JobType: z.ZodString;
7244
+ OwnerUser: z.ZodNullable<z.ZodString>;
7245
+ NotifyUser: z.ZodNullable<z.ZodString>;
7246
+ }, "strip", z.ZodTypeAny, {
7247
+ ID?: string;
7248
+ __mj_CreatedAt?: Date;
7249
+ __mj_UpdatedAt?: Date;
7250
+ Name?: string;
7251
+ Description?: string;
7252
+ Status?: "Active" | "Disabled" | "Pending" | "Expired" | "Paused";
7253
+ OwnerUserID?: string;
7254
+ OwnerUser?: string;
7255
+ Configuration?: string;
7256
+ JobTypeID?: string;
7257
+ CronExpression?: string;
7258
+ Timezone?: string;
7259
+ StartAt?: Date;
7260
+ EndAt?: Date;
7261
+ LastRunAt?: Date;
7262
+ NextRunAt?: Date;
7263
+ RunCount?: number;
7264
+ SuccessCount?: number;
7265
+ FailureCount?: number;
7266
+ NotifyOnSuccess?: boolean;
7267
+ NotifyOnFailure?: boolean;
7268
+ NotifyUserID?: string;
7269
+ NotifyViaEmail?: boolean;
7270
+ NotifyViaInApp?: boolean;
7271
+ LockToken?: string;
7272
+ LockedAt?: Date;
7273
+ LockedByInstance?: string;
7274
+ ExpectedCompletionAt?: Date;
7275
+ ConcurrencyMode?: "Concurrent" | "Queue" | "Skip";
7276
+ JobType?: string;
7277
+ NotifyUser?: string;
7278
+ }, {
7279
+ ID?: string;
7280
+ __mj_CreatedAt?: Date;
7281
+ __mj_UpdatedAt?: Date;
7282
+ Name?: string;
7283
+ Description?: string;
7284
+ Status?: "Active" | "Disabled" | "Pending" | "Expired" | "Paused";
7285
+ OwnerUserID?: string;
7286
+ OwnerUser?: string;
7287
+ Configuration?: string;
7288
+ JobTypeID?: string;
7289
+ CronExpression?: string;
7290
+ Timezone?: string;
7291
+ StartAt?: Date;
7292
+ EndAt?: Date;
7293
+ LastRunAt?: Date;
7294
+ NextRunAt?: Date;
7295
+ RunCount?: number;
7296
+ SuccessCount?: number;
7297
+ FailureCount?: number;
7298
+ NotifyOnSuccess?: boolean;
7299
+ NotifyOnFailure?: boolean;
7300
+ NotifyUserID?: string;
7301
+ NotifyViaEmail?: boolean;
7302
+ NotifyViaInApp?: boolean;
7303
+ LockToken?: string;
7304
+ LockedAt?: Date;
7305
+ LockedByInstance?: string;
7306
+ ExpectedCompletionAt?: Date;
7307
+ ConcurrencyMode?: "Concurrent" | "Queue" | "Skip";
7308
+ JobType?: string;
7309
+ NotifyUser?: string;
7310
+ }>;
7311
+ export type ScheduledJobEntityType = z.infer<typeof ScheduledJobSchema>;
7031
7312
  /**
7032
7313
  * zod schema definition for the entity MJ: Task Dependencies
7033
7314
  */
@@ -7519,9 +7800,9 @@ export declare const QueueTaskSchema: z.ZodObject<{
7519
7800
  Output?: string;
7520
7801
  ErrorMessage?: string;
7521
7802
  Data?: string;
7803
+ Queue?: string;
7522
7804
  QueueID?: string;
7523
7805
  Options?: string;
7524
- Queue?: string;
7525
7806
  }, {
7526
7807
  ID?: string;
7527
7808
  Comments?: string;
@@ -7533,9 +7814,9 @@ export declare const QueueTaskSchema: z.ZodObject<{
7533
7814
  Output?: string;
7534
7815
  ErrorMessage?: string;
7535
7816
  Data?: string;
7817
+ Queue?: string;
7536
7818
  QueueID?: string;
7537
7819
  Options?: string;
7538
- Queue?: string;
7539
7820
  }>;
7540
7821
  export type QueueTaskEntityType = z.infer<typeof QueueTaskSchema>;
7541
7822
  /**
@@ -8070,7 +8351,7 @@ export declare const ReportSchema: z.ZodObject<{
8070
8351
  Environment?: string;
8071
8352
  Thumbnail?: string;
8072
8353
  ConversationDetailID?: string;
8073
- SharingScope?: "Specific" | "None" | "Everyone";
8354
+ SharingScope?: "None" | "Specific" | "Everyone";
8074
8355
  OutputTriggerTypeID?: string;
8075
8356
  OutputFormatTypeID?: string;
8076
8357
  OutputDeliveryTypeID?: string;
@@ -8100,7 +8381,7 @@ export declare const ReportSchema: z.ZodObject<{
8100
8381
  Environment?: string;
8101
8382
  Thumbnail?: string;
8102
8383
  ConversationDetailID?: string;
8103
- SharingScope?: "Specific" | "None" | "Everyone";
8384
+ SharingScope?: "None" | "Specific" | "Everyone";
8104
8385
  OutputTriggerTypeID?: string;
8105
8386
  OutputFormatTypeID?: string;
8106
8387
  OutputDeliveryTypeID?: string;
@@ -8182,7 +8463,7 @@ export declare const ResourcePermissionSchema: z.ZodObject<{
8182
8463
  ResourceRecordID?: string;
8183
8464
  StartSharingAt?: Date;
8184
8465
  EndSharingAt?: Date;
8185
- PermissionLevel?: "View" | "Edit" | "Owner";
8466
+ PermissionLevel?: "View" | "Owner" | "Edit";
8186
8467
  }, {
8187
8468
  ID?: string;
8188
8469
  __mj_CreatedAt?: Date;
@@ -8198,7 +8479,7 @@ export declare const ResourcePermissionSchema: z.ZodObject<{
8198
8479
  ResourceRecordID?: string;
8199
8480
  StartSharingAt?: Date;
8200
8481
  EndSharingAt?: Date;
8201
- PermissionLevel?: "View" | "Edit" | "Owner";
8482
+ PermissionLevel?: "View" | "Owner" | "Edit";
8202
8483
  }>;
8203
8484
  export type ResourcePermissionEntityType = z.infer<typeof ResourcePermissionSchema>;
8204
8485
  /**
@@ -8367,9 +8648,9 @@ export declare const ScheduledActionSchema: z.ZodObject<{
8367
8648
  Description?: string;
8368
8649
  Status?: "Active" | "Disabled" | "Pending" | "Expired";
8369
8650
  Type?: "Custom" | "Daily" | "Monthly" | "Weekly" | "Yearly";
8370
- CreatedByUserID?: string;
8371
8651
  CronExpression?: string;
8372
8652
  Timezone?: string;
8653
+ CreatedByUserID?: string;
8373
8654
  IntervalDays?: number;
8374
8655
  DayOfWeek?: string;
8375
8656
  DayOfMonth?: number;
@@ -8386,9 +8667,9 @@ export declare const ScheduledActionSchema: z.ZodObject<{
8386
8667
  Description?: string;
8387
8668
  Status?: "Active" | "Disabled" | "Pending" | "Expired";
8388
8669
  Type?: "Custom" | "Daily" | "Monthly" | "Weekly" | "Yearly";
8389
- CreatedByUserID?: string;
8390
8670
  CronExpression?: string;
8391
8671
  Timezone?: string;
8672
+ CreatedByUserID?: string;
8392
8673
  IntervalDays?: number;
8393
8674
  DayOfWeek?: string;
8394
8675
  DayOfMonth?: number;
@@ -10577,6 +10858,15 @@ export declare class ActionEntity extends BaseEntity<ActionEntityType> {
10577
10858
  get IconClass(): string | null;
10578
10859
  set IconClass(value: string | null);
10579
10860
  /**
10861
+ * * Field Name: DefaultCompactPromptID
10862
+ * * Display Name: Default Compact Prompt ID
10863
+ * * SQL Data Type: uniqueidentifier
10864
+ * * Related Entity/Foreign Key: AI Prompts (vwAIPrompts.ID)
10865
+ * * Description: Default prompt for compacting/summarizing this action's results when used by agents with CompactMode=AISummary. Action designers define how their specific results should be summarized. Can be overridden per agent in AIAgentAction.CompactPromptID.
10866
+ */
10867
+ get DefaultCompactPromptID(): string | null;
10868
+ set DefaultCompactPromptID(value: string | null);
10869
+ /**
10580
10870
  * * Field Name: Category
10581
10871
  * * Display Name: Category
10582
10872
  * * SQL Data Type: nvarchar(255)
@@ -10595,6 +10885,12 @@ export declare class ActionEntity extends BaseEntity<ActionEntityType> {
10595
10885
  */
10596
10886
  get Parent(): string | null;
10597
10887
  /**
10888
+ * * Field Name: DefaultCompactPrompt
10889
+ * * Display Name: Default Compact Prompt
10890
+ * * SQL Data Type: nvarchar(255)
10891
+ */
10892
+ get DefaultCompactPrompt(): string | null;
10893
+ /**
10598
10894
  * * Field Name: RootParentID
10599
10895
  * * Display Name: Root Parent ID
10600
10896
  * * SQL Data Type: uniqueidentifier
@@ -10820,6 +11116,57 @@ export declare class AIAgentActionEntity extends BaseEntity<AIAgentActionEntityT
10820
11116
  get MaxExecutionsPerRun(): number | null;
10821
11117
  set MaxExecutionsPerRun(value: number | null);
10822
11118
  /**
11119
+ * * Field Name: ResultExpirationTurns
11120
+ * * Display Name: Result Expiration Turns
11121
+ * * SQL Data Type: int
11122
+ * * Description: Number of conversation turns before action results expire from conversation context. NULL = never expire (default). 0 = expire immediately after next turn.
11123
+ */
11124
+ get ResultExpirationTurns(): number | null;
11125
+ set ResultExpirationTurns(value: number | null);
11126
+ /**
11127
+ * * Field Name: ResultExpirationMode
11128
+ * * Display Name: Result Expiration Mode
11129
+ * * SQL Data Type: nvarchar(20)
11130
+ * * Default Value: None
11131
+ * * Value List Type: List
11132
+ * * Possible Values
11133
+ * * Remove
11134
+ * * None
11135
+ * * Compact
11136
+ * * Description: How to handle expired action results: None (no expiration, default), Remove (delete message entirely), Compact (reduce size via CompactMode while preserving key information).
11137
+ */
11138
+ get ResultExpirationMode(): 'Compact' | 'None' | 'Remove';
11139
+ set ResultExpirationMode(value: 'Compact' | 'None' | 'Remove');
11140
+ /**
11141
+ * * Field Name: CompactMode
11142
+ * * Display Name: Compact Mode
11143
+ * * SQL Data Type: nvarchar(20)
11144
+ * * Value List Type: List
11145
+ * * Possible Values
11146
+ * * AI Summary
11147
+ * * First N Chars
11148
+ * * Description: How to compact results when ResultExpirationMode=Compact: FirstNChars (truncate to CompactLength characters, fast and free), AISummary (use LLM to intelligently summarize with CompactPromptID or Action.DefaultCompactPromptID).
11149
+ */
11150
+ get CompactMode(): 'AI Summary' | 'First N Chars' | null;
11151
+ set CompactMode(value: 'AI Summary' | 'First N Chars' | null);
11152
+ /**
11153
+ * * Field Name: CompactLength
11154
+ * * Display Name: Compact Length
11155
+ * * SQL Data Type: int
11156
+ * * Description: Number of characters to keep when CompactMode=FirstNChars. Required when CompactMode is FirstNChars, ignored otherwise.
11157
+ */
11158
+ get CompactLength(): number | null;
11159
+ set CompactLength(value: number | null);
11160
+ /**
11161
+ * * Field Name: CompactPromptID
11162
+ * * Display Name: Compact Prompt ID
11163
+ * * SQL Data Type: uniqueidentifier
11164
+ * * Related Entity/Foreign Key: AI Prompts (vwAIPrompts.ID)
11165
+ * * Description: Optional override for AI summarization prompt when CompactMode=AISummary. Lookup hierarchy: this field -> Action.DefaultCompactPromptID -> system default. Allows agent-specific summarization focus (e.g., technical vs. marketing perspective).
11166
+ */
11167
+ get CompactPromptID(): string | null;
11168
+ set CompactPromptID(value: string | null);
11169
+ /**
10823
11170
  * * Field Name: Agent
10824
11171
  * * Display Name: Agent
10825
11172
  * * SQL Data Type: nvarchar(255)
@@ -10831,6 +11178,12 @@ export declare class AIAgentActionEntity extends BaseEntity<AIAgentActionEntityT
10831
11178
  * * SQL Data Type: nvarchar(425)
10832
11179
  */
10833
11180
  get Action(): string | null;
11181
+ /**
11182
+ * * Field Name: CompactPrompt
11183
+ * * Display Name: Compact Prompt
11184
+ * * SQL Data Type: nvarchar(255)
11185
+ */
11186
+ get CompactPrompt(): string | null;
10834
11187
  }
10835
11188
  /**
10836
11189
  * AI Agent Learning Cycles - strongly typed entity sub-class
@@ -11781,6 +12134,20 @@ if this limit is exceeded.
11781
12134
  get OwnerUserID(): string;
11782
12135
  set OwnerUserID(value: string);
11783
12136
  /**
12137
+ * * Field Name: InvocationMode
12138
+ * * Display Name: Invocation Mode
12139
+ * * SQL Data Type: nvarchar(20)
12140
+ * * Default Value: Any
12141
+ * * Value List Type: List
12142
+ * * Possible Values
12143
+ * * Sub-Agent
12144
+ * * Any
12145
+ * * Top-Level
12146
+ * * Description: Controls how the agent can be invoked: Any (default - can be top-level or sub-agent), Top-Level (only callable as primary agent), Sub-Agent (only callable as sub-agent). Used to filter available agents in tools like Sage.
12147
+ */
12148
+ get InvocationMode(): 'Any' | 'Sub-Agent' | 'Top-Level';
12149
+ set InvocationMode(value: 'Any' | 'Sub-Agent' | 'Top-Level');
12150
+ /**
11784
12151
  * * Field Name: Parent
11785
12152
  * * Display Name: Parent
11786
12153
  * * SQL Data Type: nvarchar(255)
@@ -16293,6 +16660,14 @@ export declare class ConversationDetailEntity extends BaseEntity<ConversationDet
16293
16660
  get Status(): 'Complete' | 'Error' | 'In-Progress';
16294
16661
  set Status(value: 'Complete' | 'Error' | 'In-Progress');
16295
16662
  /**
16663
+ * * Field Name: SuggestedResponses
16664
+ * * Display Name: Suggested Responses
16665
+ * * SQL Data Type: nvarchar(MAX)
16666
+ * * Description: JSON array of suggested responses that can be displayed to the user for quick replies. Each response object contains: text (display text), allowInput (boolean), iconClass (optional Font Awesome class), and data (optional payload).
16667
+ */
16668
+ get SuggestedResponses(): string | null;
16669
+ set SuggestedResponses(value: string | null);
16670
+ /**
16296
16671
  * * Field Name: Conversation
16297
16672
  * * Display Name: Conversation
16298
16673
  * * SQL Data Type: nvarchar(255)
@@ -23297,6 +23672,30 @@ export declare class AIAgentRelationshipEntity extends BaseEntity<AIAgentRelatio
23297
23672
  */
23298
23673
  get __mj_UpdatedAt(): Date;
23299
23674
  /**
23675
+ * * Field Name: SubAgentOutputMapping
23676
+ * * Display Name: Sub Agent Output Mapping
23677
+ * * SQL Data Type: nvarchar(MAX)
23678
+ * * Description: JSON configuration mapping sub-agent result payload paths to parent agent payload paths. Enables controlled merging of sub-agent results. Format: {"subAgentPath": "parentPath", "*": "captureAllPath"}. If null, sub-agent results are not automatically merged into parent payload.
23679
+ */
23680
+ get SubAgentOutputMapping(): string | null;
23681
+ set SubAgentOutputMapping(value: string | null);
23682
+ /**
23683
+ * * Field Name: SubAgentInputMapping
23684
+ * * Display Name: Sub Agent Input Mapping
23685
+ * * SQL Data Type: nvarchar(MAX)
23686
+ * * Description: JSON mapping of parent payload paths to sub-agent initial payload paths. Enables structural data transfer from parent to related sub-agent. Format: {"parentPath": "subAgentPath", "parent.nested": "subAgent.field"}. Example: {"searchQuery": "query", "maxResults": "limit"}. If null, sub-agent starts with empty payload (default behavior).
23687
+ */
23688
+ get SubAgentInputMapping(): string | null;
23689
+ set SubAgentInputMapping(value: string | null);
23690
+ /**
23691
+ * * Field Name: SubAgentContextPaths
23692
+ * * Display Name: Sub Agent Context Paths
23693
+ * * SQL Data Type: nvarchar(MAX)
23694
+ * * Description: JSON array of parent payload paths to send as LLM context to related sub-agent. Sub-agent receives this data in a formatted context message before its task message. Format: ["path1", "path2.nested", "path3.*", "*"]. Use "*" to send entire parent payload. Example: ["userPreferences", "priorFindings.summary", "sources[*]"]. If null, no parent context is sent (default behavior).
23695
+ */
23696
+ get SubAgentContextPaths(): string | null;
23697
+ set SubAgentContextPaths(value: string | null);
23698
+ /**
23300
23699
  * * Field Name: Agent
23301
23700
  * * Display Name: Agent
23302
23701
  * * SQL Data Type: nvarchar(255)
@@ -23950,6 +24349,15 @@ each time the agent processes a prompt step.
23950
24349
  get Comments(): string | null;
23951
24350
  set Comments(value: string | null);
23952
24351
  /**
24352
+ * * Field Name: ScheduledJobRunID
24353
+ * * Display Name: Scheduled Job Run ID
24354
+ * * SQL Data Type: uniqueidentifier
24355
+ * * Related Entity/Foreign Key: MJ: Scheduled Job Runs (vwScheduledJobRuns.ID)
24356
+ * * Description: Links to the scheduled job run that triggered this agent execution. NULL for manually-triggered agent runs. Enables tracking which scheduled jobs spawned which agent executions.
24357
+ */
24358
+ get ScheduledJobRunID(): string | null;
24359
+ set ScheduledJobRunID(value: string | null);
24360
+ /**
23953
24361
  * * Field Name: Agent
23954
24362
  * * Display Name: Agent
23955
24363
  * * SQL Data Type: nvarchar(255)
@@ -27139,25 +27547,25 @@ export declare class CollectionArtifactEntity extends BaseEntity<CollectionArtif
27139
27547
  get Artifact(): string;
27140
27548
  }
27141
27549
  /**
27142
- * MJ: Collections - strongly typed entity sub-class
27550
+ * MJ: Collection Permissions - strongly typed entity sub-class
27143
27551
  * * Schema: __mj
27144
- * * Base Table: Collection
27145
- * * Base View: vwCollections
27146
- * * @description Organizational folders for storing and categorizing artifacts. Supports nested folder structure for hierarchical organization.
27552
+ * * Base Table: CollectionPermission
27553
+ * * Base View: vwCollectionPermissions
27554
+ * * @description Manages sharing permissions for collections, allowing granular access control
27147
27555
  * * Primary Key: ID
27148
27556
  * @extends {BaseEntity}
27149
27557
  * @class
27150
27558
  * @public
27151
27559
  */
27152
- export declare class CollectionEntity extends BaseEntity<CollectionEntityType> {
27560
+ export declare class CollectionPermissionEntity extends BaseEntity<CollectionPermissionEntityType> {
27153
27561
  /**
27154
- * Loads the MJ: Collections record from the database
27155
- * @param ID: string - primary key value to load the MJ: Collections record.
27562
+ * Loads the MJ: Collection Permissions record from the database
27563
+ * @param ID: string - primary key value to load the MJ: Collection Permissions record.
27156
27564
  * @param EntityRelationshipsToLoad - (optional) the relationships to load
27157
27565
  * @returns {Promise<boolean>} - true if successful, false otherwise
27158
27566
  * @public
27159
27567
  * @async
27160
- * @memberof CollectionEntity
27568
+ * @memberof CollectionPermissionEntity
27161
27569
  * @method
27162
27570
  * @override
27163
27571
  */
@@ -27171,53 +27579,179 @@ export declare class CollectionEntity extends BaseEntity<CollectionEntityType> {
27171
27579
  get ID(): string;
27172
27580
  set ID(value: string);
27173
27581
  /**
27174
- * * Field Name: EnvironmentID
27175
- * * Display Name: Environment ID
27582
+ * * Field Name: CollectionID
27583
+ * * Display Name: Collection ID
27176
27584
  * * SQL Data Type: uniqueidentifier
27177
- * * Related Entity/Foreign Key: MJ: Environments (vwEnvironments.ID)
27178
- * * Default Value: F51358F3-9447-4176-B313-BF8025FD8D09
27585
+ * * Related Entity/Foreign Key: MJ: Collections (vwCollections.ID)
27179
27586
  */
27180
- get EnvironmentID(): string;
27181
- set EnvironmentID(value: string);
27587
+ get CollectionID(): string;
27588
+ set CollectionID(value: string);
27182
27589
  /**
27183
- * * Field Name: ParentID
27184
- * * Display Name: Parent ID
27590
+ * * Field Name: UserID
27591
+ * * Display Name: User ID
27185
27592
  * * SQL Data Type: uniqueidentifier
27186
- * * Related Entity/Foreign Key: MJ: Collections (vwCollections.ID)
27593
+ * * Related Entity/Foreign Key: Users (vwUsers.ID)
27187
27594
  */
27188
- get ParentID(): string | null;
27189
- set ParentID(value: string | null);
27595
+ get UserID(): string;
27596
+ set UserID(value: string);
27190
27597
  /**
27191
- * * Field Name: Name
27192
- * * Display Name: Name
27193
- * * SQL Data Type: nvarchar(255)
27194
- * * Description: Display name for the collection
27598
+ * * Field Name: CanRead
27599
+ * * Display Name: Can Read
27600
+ * * SQL Data Type: bit
27601
+ * * Default Value: 1
27602
+ * * Description: Always 1 - users must have read permission to access a shared collection
27195
27603
  */
27196
- get Name(): string;
27197
- set Name(value: string);
27604
+ get CanRead(): boolean;
27605
+ set CanRead(value: boolean);
27198
27606
  /**
27199
- * * Field Name: Description
27200
- * * Display Name: Description
27201
- * * SQL Data Type: nvarchar(MAX)
27202
- * * Description: Detailed description of the collection purpose
27607
+ * * Field Name: CanShare
27608
+ * * Display Name: Can Share
27609
+ * * SQL Data Type: bit
27610
+ * * Default Value: 0
27611
+ * * Description: Can share this collection with others (but cannot grant more permissions than they have)
27203
27612
  */
27204
- get Description(): string | null;
27205
- set Description(value: string | null);
27613
+ get CanShare(): boolean;
27614
+ set CanShare(value: boolean);
27206
27615
  /**
27207
- * * Field Name: Icon
27208
- * * Display Name: Icon
27209
- * * SQL Data Type: nvarchar(50)
27210
- * * Description: Font Awesome icon class for UI display
27616
+ * * Field Name: CanEdit
27617
+ * * Display Name: Can Edit
27618
+ * * SQL Data Type: bit
27619
+ * * Default Value: 0
27620
+ * * Description: Can add/remove artifacts to/from this collection
27211
27621
  */
27212
- get Icon(): string | null;
27213
- set Icon(value: string | null);
27622
+ get CanEdit(): boolean;
27623
+ set CanEdit(value: boolean);
27214
27624
  /**
27215
- * * Field Name: Color
27216
- * * Display Name: Color
27217
- * * SQL Data Type: nvarchar(7)
27218
- * * Description: Hex color code for UI display (#RRGGBB format)
27219
- */
27220
- get Color(): string | null;
27625
+ * * Field Name: CanDelete
27626
+ * * Display Name: Can Delete
27627
+ * * SQL Data Type: bit
27628
+ * * Default Value: 0
27629
+ * * Description: Can delete the collection, child collections, and artifacts
27630
+ */
27631
+ get CanDelete(): boolean;
27632
+ set CanDelete(value: boolean);
27633
+ /**
27634
+ * * Field Name: SharedByUserID
27635
+ * * Display Name: Shared By User ID
27636
+ * * SQL Data Type: uniqueidentifier
27637
+ * * Related Entity/Foreign Key: Users (vwUsers.ID)
27638
+ * * Description: The user who shared this collection (NULL if shared by owner)
27639
+ */
27640
+ get SharedByUserID(): string | null;
27641
+ set SharedByUserID(value: string | null);
27642
+ /**
27643
+ * * Field Name: __mj_CreatedAt
27644
+ * * Display Name: Created At
27645
+ * * SQL Data Type: datetimeoffset
27646
+ * * Default Value: getutcdate()
27647
+ */
27648
+ get __mj_CreatedAt(): Date;
27649
+ /**
27650
+ * * Field Name: __mj_UpdatedAt
27651
+ * * Display Name: Updated At
27652
+ * * SQL Data Type: datetimeoffset
27653
+ * * Default Value: getutcdate()
27654
+ */
27655
+ get __mj_UpdatedAt(): Date;
27656
+ /**
27657
+ * * Field Name: Collection
27658
+ * * Display Name: Collection
27659
+ * * SQL Data Type: nvarchar(255)
27660
+ */
27661
+ get Collection(): string;
27662
+ /**
27663
+ * * Field Name: User
27664
+ * * Display Name: User
27665
+ * * SQL Data Type: nvarchar(100)
27666
+ */
27667
+ get User(): string;
27668
+ /**
27669
+ * * Field Name: SharedByUser
27670
+ * * Display Name: Shared By User
27671
+ * * SQL Data Type: nvarchar(100)
27672
+ */
27673
+ get SharedByUser(): string | null;
27674
+ }
27675
+ /**
27676
+ * MJ: Collections - strongly typed entity sub-class
27677
+ * * Schema: __mj
27678
+ * * Base Table: Collection
27679
+ * * Base View: vwCollections
27680
+ * * @description Organizational folders for storing and categorizing artifacts. Supports nested folder structure for hierarchical organization.
27681
+ * * Primary Key: ID
27682
+ * @extends {BaseEntity}
27683
+ * @class
27684
+ * @public
27685
+ */
27686
+ export declare class CollectionEntity extends BaseEntity<CollectionEntityType> {
27687
+ /**
27688
+ * Loads the MJ: Collections record from the database
27689
+ * @param ID: string - primary key value to load the MJ: Collections record.
27690
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
27691
+ * @returns {Promise<boolean>} - true if successful, false otherwise
27692
+ * @public
27693
+ * @async
27694
+ * @memberof CollectionEntity
27695
+ * @method
27696
+ * @override
27697
+ */
27698
+ Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
27699
+ /**
27700
+ * * Field Name: ID
27701
+ * * Display Name: ID
27702
+ * * SQL Data Type: uniqueidentifier
27703
+ * * Default Value: newsequentialid()
27704
+ */
27705
+ get ID(): string;
27706
+ set ID(value: string);
27707
+ /**
27708
+ * * Field Name: EnvironmentID
27709
+ * * Display Name: Environment ID
27710
+ * * SQL Data Type: uniqueidentifier
27711
+ * * Related Entity/Foreign Key: MJ: Environments (vwEnvironments.ID)
27712
+ * * Default Value: F51358F3-9447-4176-B313-BF8025FD8D09
27713
+ */
27714
+ get EnvironmentID(): string;
27715
+ set EnvironmentID(value: string);
27716
+ /**
27717
+ * * Field Name: ParentID
27718
+ * * Display Name: Parent ID
27719
+ * * SQL Data Type: uniqueidentifier
27720
+ * * Related Entity/Foreign Key: MJ: Collections (vwCollections.ID)
27721
+ */
27722
+ get ParentID(): string | null;
27723
+ set ParentID(value: string | null);
27724
+ /**
27725
+ * * Field Name: Name
27726
+ * * Display Name: Name
27727
+ * * SQL Data Type: nvarchar(255)
27728
+ * * Description: Display name for the collection
27729
+ */
27730
+ get Name(): string;
27731
+ set Name(value: string);
27732
+ /**
27733
+ * * Field Name: Description
27734
+ * * Display Name: Description
27735
+ * * SQL Data Type: nvarchar(MAX)
27736
+ * * Description: Detailed description of the collection purpose
27737
+ */
27738
+ get Description(): string | null;
27739
+ set Description(value: string | null);
27740
+ /**
27741
+ * * Field Name: Icon
27742
+ * * Display Name: Icon
27743
+ * * SQL Data Type: nvarchar(50)
27744
+ * * Description: Font Awesome icon class for UI display
27745
+ */
27746
+ get Icon(): string | null;
27747
+ set Icon(value: string | null);
27748
+ /**
27749
+ * * Field Name: Color
27750
+ * * Display Name: Color
27751
+ * * SQL Data Type: nvarchar(7)
27752
+ * * Description: Hex color code for UI display (#RRGGBB format)
27753
+ */
27754
+ get Color(): string | null;
27221
27755
  set Color(value: string | null);
27222
27756
  /**
27223
27757
  * * Field Name: Sequence
@@ -27242,6 +27776,15 @@ export declare class CollectionEntity extends BaseEntity<CollectionEntityType> {
27242
27776
  */
27243
27777
  get __mj_UpdatedAt(): Date;
27244
27778
  /**
27779
+ * * Field Name: OwnerID
27780
+ * * Display Name: Owner ID
27781
+ * * SQL Data Type: uniqueidentifier
27782
+ * * Related Entity/Foreign Key: Users (vwUsers.ID)
27783
+ * * Description: The user who owns this collection and has full permissions
27784
+ */
27785
+ get OwnerID(): string | null;
27786
+ set OwnerID(value: string | null);
27787
+ /**
27245
27788
  * * Field Name: Environment
27246
27789
  * * Display Name: Environment
27247
27790
  * * SQL Data Type: nvarchar(255)
@@ -27254,6 +27797,12 @@ export declare class CollectionEntity extends BaseEntity<CollectionEntityType> {
27254
27797
  */
27255
27798
  get Parent(): string | null;
27256
27799
  /**
27800
+ * * Field Name: Owner
27801
+ * * Display Name: Owner
27802
+ * * SQL Data Type: nvarchar(100)
27803
+ */
27804
+ get Owner(): string | null;
27805
+ /**
27257
27806
  * * Field Name: RootParentID
27258
27807
  * * Display Name: Root Parent ID
27259
27808
  * * SQL Data Type: uniqueidentifier
@@ -29398,6 +29947,562 @@ export declare class ReportVersionEntity extends BaseEntity<ReportVersionEntityT
29398
29947
  */
29399
29948
  get Report(): string;
29400
29949
  }
29950
+ /**
29951
+ * MJ: Scheduled Job Runs - strongly typed entity sub-class
29952
+ * * Schema: __mj
29953
+ * * Base Table: ScheduledJobRun
29954
+ * * Base View: vwScheduledJobRuns
29955
+ * * @description Records execution history for scheduled jobs. Provides uniform tracking across all job types. Each record represents one execution attempt of a scheduled job.
29956
+ * * Primary Key: ID
29957
+ * @extends {BaseEntity}
29958
+ * @class
29959
+ * @public
29960
+ */
29961
+ export declare class ScheduledJobRunEntity extends BaseEntity<ScheduledJobRunEntityType> {
29962
+ /**
29963
+ * Loads the MJ: Scheduled Job Runs record from the database
29964
+ * @param ID: string - primary key value to load the MJ: Scheduled Job Runs record.
29965
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
29966
+ * @returns {Promise<boolean>} - true if successful, false otherwise
29967
+ * @public
29968
+ * @async
29969
+ * @memberof ScheduledJobRunEntity
29970
+ * @method
29971
+ * @override
29972
+ */
29973
+ Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
29974
+ /**
29975
+ * Validate() method override for MJ: Scheduled Job Runs entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
29976
+ * * Details: This rule ensures that if the Details field is not empty, it must contain a valid JSON value.
29977
+ * @public
29978
+ * @method
29979
+ * @override
29980
+ */
29981
+ Validate(): ValidationResult;
29982
+ /**
29983
+ * This rule ensures that if the Details field is not empty, it must contain a valid JSON value.
29984
+ * @param result - the ValidationResult object to add any errors or warnings to
29985
+ * @public
29986
+ * @method
29987
+ */
29988
+ ValidateDetailsAsJson(result: ValidationResult): void;
29989
+ /**
29990
+ * * Field Name: ID
29991
+ * * Display Name: ID
29992
+ * * SQL Data Type: uniqueidentifier
29993
+ * * Default Value: newsequentialid()
29994
+ */
29995
+ get ID(): string;
29996
+ set ID(value: string);
29997
+ /**
29998
+ * * Field Name: ScheduledJobID
29999
+ * * Display Name: Scheduled Job ID
30000
+ * * SQL Data Type: uniqueidentifier
30001
+ * * Related Entity/Foreign Key: MJ: Scheduled Jobs (vwScheduledJobs.ID)
30002
+ */
30003
+ get ScheduledJobID(): string;
30004
+ set ScheduledJobID(value: string);
30005
+ /**
30006
+ * * Field Name: StartedAt
30007
+ * * Display Name: Started At
30008
+ * * SQL Data Type: datetimeoffset
30009
+ * * Default Value: sysdatetimeoffset()
30010
+ * * Description: Timestamp when this job execution began. Set immediately before calling the job plugin's Execute method.
30011
+ */
30012
+ get StartedAt(): Date;
30013
+ set StartedAt(value: Date);
30014
+ /**
30015
+ * * Field Name: CompletedAt
30016
+ * * Display Name: Completed At
30017
+ * * SQL Data Type: datetimeoffset
30018
+ * * Description: Timestamp when this job execution completed (successfully or with failure). NULL while the job is still running.
30019
+ */
30020
+ get CompletedAt(): Date | null;
30021
+ set CompletedAt(value: Date | null);
30022
+ /**
30023
+ * * Field Name: Status
30024
+ * * Display Name: Status
30025
+ * * SQL Data Type: nvarchar(20)
30026
+ * * Default Value: Running
30027
+ * * Value List Type: List
30028
+ * * Possible Values
30029
+ * * Running
30030
+ * * Timeout
30031
+ * * Completed
30032
+ * * Cancelled
30033
+ * * Failed
30034
+ * * Description: Current status of the job execution. Running=currently executing, Completed=finished (check Success for outcome), Failed=exception during execution, Cancelled=manually cancelled, Timeout=exceeded maximum execution time.
30035
+ */
30036
+ get Status(): 'Cancelled' | 'Completed' | 'Failed' | 'Running' | 'Timeout';
30037
+ set Status(value: 'Cancelled' | 'Completed' | 'Failed' | 'Running' | 'Timeout');
30038
+ /**
30039
+ * * Field Name: Success
30040
+ * * Display Name: Success
30041
+ * * SQL Data Type: bit
30042
+ * * Description: Whether the job execution completed successfully. NULL while running, TRUE if successful, FALSE if failed. This is the job-level success from the plugin's Execute method, separate from domain-specific success tracking.
30043
+ */
30044
+ get Success(): boolean | null;
30045
+ set Success(value: boolean | null);
30046
+ /**
30047
+ * * Field Name: ErrorMessage
30048
+ * * Display Name: Error Message
30049
+ * * SQL Data Type: nvarchar(MAX)
30050
+ * * Description: Error message if the job failed. NULL for successful runs. Contains exception messages or error details from the plugin's Execute method.
30051
+ */
30052
+ get ErrorMessage(): string | null;
30053
+ set ErrorMessage(value: string | null);
30054
+ /**
30055
+ * * Field Name: Details
30056
+ * * Display Name: Details
30057
+ * * SQL Data Type: nvarchar(MAX)
30058
+ * * Description: Job-type specific execution details stored as JSON. May include references to domain-specific run records (e.g., {"AgentRunID": "...", "TokensUsed": 5000}), performance metrics, or other execution metadata. Schema is defined by the job type plugin.
30059
+ */
30060
+ get Details(): string | null;
30061
+ set Details(value: string | null);
30062
+ /**
30063
+ * * Field Name: ExecutedByUserID
30064
+ * * Display Name: Executed By User ID
30065
+ * * SQL Data Type: uniqueidentifier
30066
+ * * Related Entity/Foreign Key: Users (vwUsers.ID)
30067
+ * * Description: User context under which the job was executed. Typically the OwnerUserID from the schedule, but can be overridden in job-specific configuration.
30068
+ */
30069
+ get ExecutedByUserID(): string | null;
30070
+ set ExecutedByUserID(value: string | null);
30071
+ /**
30072
+ * * Field Name: QueuedAt
30073
+ * * Display Name: Queued At
30074
+ * * SQL Data Type: datetimeoffset
30075
+ * * Description: Timestamp when this execution was queued (for ConcurrencyMode=Queue). NULL for immediate executions. When set, indicates this run is waiting for a previous execution to complete before starting.
30076
+ */
30077
+ get QueuedAt(): Date | null;
30078
+ set QueuedAt(value: Date | null);
30079
+ /**
30080
+ * * Field Name: __mj_CreatedAt
30081
+ * * Display Name: Created At
30082
+ * * SQL Data Type: datetimeoffset
30083
+ * * Default Value: getutcdate()
30084
+ */
30085
+ get __mj_CreatedAt(): Date;
30086
+ /**
30087
+ * * Field Name: __mj_UpdatedAt
30088
+ * * Display Name: Updated At
30089
+ * * SQL Data Type: datetimeoffset
30090
+ * * Default Value: getutcdate()
30091
+ */
30092
+ get __mj_UpdatedAt(): Date;
30093
+ /**
30094
+ * * Field Name: ScheduledJob
30095
+ * * Display Name: Scheduled Job
30096
+ * * SQL Data Type: nvarchar(200)
30097
+ */
30098
+ get ScheduledJob(): string;
30099
+ /**
30100
+ * * Field Name: ExecutedByUser
30101
+ * * Display Name: Executed By User
30102
+ * * SQL Data Type: nvarchar(100)
30103
+ */
30104
+ get ExecutedByUser(): string | null;
30105
+ }
30106
+ /**
30107
+ * MJ: Scheduled Job Types - strongly typed entity sub-class
30108
+ * * Schema: __mj
30109
+ * * Base Table: ScheduledJobType
30110
+ * * Base View: vwScheduledJobTypes
30111
+ * * @description Defines types of schedulable jobs and their plugin implementations. Each job type represents a different kind of work that can be scheduled (e.g., Agents, Actions, Reports).
30112
+ * * Primary Key: ID
30113
+ * @extends {BaseEntity}
30114
+ * @class
30115
+ * @public
30116
+ */
30117
+ export declare class ScheduledJobTypeEntity extends BaseEntity<ScheduledJobTypeEntityType> {
30118
+ /**
30119
+ * Loads the MJ: Scheduled Job Types record from the database
30120
+ * @param ID: string - primary key value to load the MJ: Scheduled Job Types record.
30121
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
30122
+ * @returns {Promise<boolean>} - true if successful, false otherwise
30123
+ * @public
30124
+ * @async
30125
+ * @memberof ScheduledJobTypeEntity
30126
+ * @method
30127
+ * @override
30128
+ */
30129
+ Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
30130
+ /**
30131
+ * * Field Name: ID
30132
+ * * Display Name: ID
30133
+ * * SQL Data Type: uniqueidentifier
30134
+ * * Default Value: newsequentialid()
30135
+ */
30136
+ get ID(): string;
30137
+ set ID(value: string);
30138
+ /**
30139
+ * * Field Name: Name
30140
+ * * Display Name: Name
30141
+ * * SQL Data Type: nvarchar(100)
30142
+ * * Description: Unique name identifying this job type (e.g., Agent, Action, Report).
30143
+ */
30144
+ get Name(): string;
30145
+ set Name(value: string);
30146
+ /**
30147
+ * * Field Name: Description
30148
+ * * Display Name: Description
30149
+ * * SQL Data Type: nvarchar(MAX)
30150
+ * * Description: Human-readable description of what this job type does and when it should be used.
30151
+ */
30152
+ get Description(): string | null;
30153
+ set Description(value: string | null);
30154
+ /**
30155
+ * * Field Name: DriverClass
30156
+ * * Display Name: Driver Class
30157
+ * * SQL Data Type: nvarchar(255)
30158
+ * * Description: TypeScript class name that implements BaseScheduledJob for this job type. Used by ClassFactory to instantiate the correct plugin at runtime.
30159
+ */
30160
+ get DriverClass(): string;
30161
+ set DriverClass(value: string);
30162
+ /**
30163
+ * * Field Name: DomainRunEntity
30164
+ * * Display Name: Domain Run Entity
30165
+ * * SQL Data Type: nvarchar(255)
30166
+ * * Description: Name of the entity that stores execution records for this job type (e.g., "MJ: AI Agent Runs", "Action Execution Logs"). Used for generic UI linking to domain-specific run records. NULL if job type uses ScheduledJobRun as its only execution record.
30167
+ */
30168
+ get DomainRunEntity(): string | null;
30169
+ set DomainRunEntity(value: string | null);
30170
+ /**
30171
+ * * Field Name: DomainRunEntityFKey
30172
+ * * Display Name: Domain Run Entity F Key
30173
+ * * SQL Data Type: nvarchar(100)
30174
+ * * Description: Name of the foreign key field in the DomainRunEntity that links back to ScheduledJobRun (e.g., "ScheduleID"). Used for querying related domain runs. NULL if DomainRunEntity is NULL.
30175
+ */
30176
+ get DomainRunEntityFKey(): string | null;
30177
+ set DomainRunEntityFKey(value: string | null);
30178
+ /**
30179
+ * * Field Name: NotificationsAvailable
30180
+ * * Display Name: Notifications Available
30181
+ * * SQL Data Type: bit
30182
+ * * Default Value: 1
30183
+ * * Description: Indicates whether this job type supports sending notifications on completion or failure.
30184
+ */
30185
+ get NotificationsAvailable(): boolean;
30186
+ set NotificationsAvailable(value: boolean);
30187
+ /**
30188
+ * * Field Name: __mj_CreatedAt
30189
+ * * Display Name: Created At
30190
+ * * SQL Data Type: datetimeoffset
30191
+ * * Default Value: getutcdate()
30192
+ */
30193
+ get __mj_CreatedAt(): Date;
30194
+ /**
30195
+ * * Field Name: __mj_UpdatedAt
30196
+ * * Display Name: Updated At
30197
+ * * SQL Data Type: datetimeoffset
30198
+ * * Default Value: getutcdate()
30199
+ */
30200
+ get __mj_UpdatedAt(): Date;
30201
+ }
30202
+ /**
30203
+ * MJ: Scheduled Jobs - strongly typed entity sub-class
30204
+ * * Schema: __mj
30205
+ * * Base Table: ScheduledJob
30206
+ * * Base View: vwScheduledJobs
30207
+ * * @description Defines schedules for automated job execution across all schedulable types. Each record represents a scheduled job with its cron expression, configuration, and execution tracking.
30208
+ * * Primary Key: ID
30209
+ * @extends {BaseEntity}
30210
+ * @class
30211
+ * @public
30212
+ */
30213
+ export declare class ScheduledJobEntity extends BaseEntity<ScheduledJobEntityType> {
30214
+ /**
30215
+ * Loads the MJ: Scheduled Jobs record from the database
30216
+ * @param ID: string - primary key value to load the MJ: Scheduled Jobs record.
30217
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
30218
+ * @returns {Promise<boolean>} - true if successful, false otherwise
30219
+ * @public
30220
+ * @async
30221
+ * @memberof ScheduledJobEntity
30222
+ * @method
30223
+ * @override
30224
+ */
30225
+ Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
30226
+ /**
30227
+ * Validate() method override for MJ: Scheduled Jobs entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
30228
+ * * Configuration: This rule ensures that if the Configuration field has a value, it must be valid JSON. If the Configuration field is empty or not set, this rule does not apply.
30229
+ * @public
30230
+ * @method
30231
+ * @override
30232
+ */
30233
+ Validate(): ValidationResult;
30234
+ /**
30235
+ * This rule ensures that if the Configuration field has a value, it must be valid JSON. If the Configuration field is empty or not set, this rule does not apply.
30236
+ * @param result - the ValidationResult object to add any errors or warnings to
30237
+ * @public
30238
+ * @method
30239
+ */
30240
+ ValidateConfigurationIsJson(result: ValidationResult): void;
30241
+ /**
30242
+ * * Field Name: ID
30243
+ * * Display Name: ID
30244
+ * * SQL Data Type: uniqueidentifier
30245
+ * * Default Value: newsequentialid()
30246
+ */
30247
+ get ID(): string;
30248
+ set ID(value: string);
30249
+ /**
30250
+ * * Field Name: JobTypeID
30251
+ * * Display Name: Job Type ID
30252
+ * * SQL Data Type: uniqueidentifier
30253
+ * * Related Entity/Foreign Key: MJ: Scheduled Job Types (vwScheduledJobTypes.ID)
30254
+ */
30255
+ get JobTypeID(): string;
30256
+ set JobTypeID(value: string);
30257
+ /**
30258
+ * * Field Name: Name
30259
+ * * Display Name: Name
30260
+ * * SQL Data Type: nvarchar(200)
30261
+ * * Description: Human-readable name for this scheduled job. Should clearly identify what the job does.
30262
+ */
30263
+ get Name(): string;
30264
+ set Name(value: string);
30265
+ /**
30266
+ * * Field Name: Description
30267
+ * * Display Name: Description
30268
+ * * SQL Data Type: nvarchar(MAX)
30269
+ * * Description: Detailed description of the job's purpose, what it does, and any important notes about its execution.
30270
+ */
30271
+ get Description(): string | null;
30272
+ set Description(value: string | null);
30273
+ /**
30274
+ * * Field Name: CronExpression
30275
+ * * Display Name: Cron Expression
30276
+ * * SQL Data Type: nvarchar(120)
30277
+ * * Description: Cron expression defining when the job should execute (e.g., "0 30 9 * * MON-FRI" for weekdays at 9:30 AM). Uses standard cron syntax with seconds precision.
30278
+ */
30279
+ get CronExpression(): string;
30280
+ set CronExpression(value: string);
30281
+ /**
30282
+ * * Field Name: Timezone
30283
+ * * Display Name: Timezone
30284
+ * * SQL Data Type: nvarchar(64)
30285
+ * * Default Value: UTC
30286
+ * * Description: IANA timezone identifier for interpreting the cron expression (e.g., "America/Chicago", "UTC"). Ensures consistent scheduling across different server locations.
30287
+ */
30288
+ get Timezone(): string;
30289
+ set Timezone(value: string);
30290
+ /**
30291
+ * * Field Name: StartAt
30292
+ * * Display Name: Start At
30293
+ * * SQL Data Type: datetimeoffset
30294
+ * * Description: Optional start date/time for when this schedule becomes active. Job will not execute before this time. NULL means active immediately upon creation.
30295
+ */
30296
+ get StartAt(): Date | null;
30297
+ set StartAt(value: Date | null);
30298
+ /**
30299
+ * * Field Name: EndAt
30300
+ * * Display Name: End At
30301
+ * * SQL Data Type: datetimeoffset
30302
+ * * Description: Optional end date/time for when this schedule expires. Job will not execute after this time. NULL means no expiration.
30303
+ */
30304
+ get EndAt(): Date | null;
30305
+ set EndAt(value: Date | null);
30306
+ /**
30307
+ * * Field Name: Status
30308
+ * * Display Name: Status
30309
+ * * SQL Data Type: nvarchar(20)
30310
+ * * Default Value: Pending
30311
+ * * Value List Type: List
30312
+ * * Possible Values
30313
+ * * Paused
30314
+ * * Disabled
30315
+ * * Expired
30316
+ * * Pending
30317
+ * * Active
30318
+ * * Description: Current status of the schedule. Pending=created but not yet active, Active=currently running on schedule, Paused=temporarily stopped, Disabled=manually disabled, Expired=past EndAt date.
30319
+ */
30320
+ get Status(): 'Active' | 'Disabled' | 'Expired' | 'Paused' | 'Pending';
30321
+ set Status(value: 'Active' | 'Disabled' | 'Expired' | 'Paused' | 'Pending');
30322
+ /**
30323
+ * * Field Name: Configuration
30324
+ * * Display Name: Configuration
30325
+ * * SQL Data Type: nvarchar(MAX)
30326
+ * * Description: Job-type specific configuration stored as JSON. Schema is defined by the ScheduledJobType plugin. For Agents: includes AgentID, StartingPayload, InitialMessage, etc. For Actions: includes ActionID and parameter mappings.
30327
+ */
30328
+ get Configuration(): string | null;
30329
+ set Configuration(value: string | null);
30330
+ /**
30331
+ * * Field Name: OwnerUserID
30332
+ * * Display Name: Owner User ID
30333
+ * * SQL Data Type: uniqueidentifier
30334
+ * * Related Entity/Foreign Key: Users (vwUsers.ID)
30335
+ * * Description: User who owns this schedule. Used as the execution context if no specific user is configured in the job-specific configuration.
30336
+ */
30337
+ get OwnerUserID(): string | null;
30338
+ set OwnerUserID(value: string | null);
30339
+ /**
30340
+ * * Field Name: LastRunAt
30341
+ * * Display Name: Last Run At
30342
+ * * SQL Data Type: datetimeoffset
30343
+ * * Description: Timestamp of the most recent execution. Updated after each run. Used for monitoring and dashboard displays.
30344
+ */
30345
+ get LastRunAt(): Date | null;
30346
+ set LastRunAt(value: Date | null);
30347
+ /**
30348
+ * * Field Name: NextRunAt
30349
+ * * Display Name: Next Run At
30350
+ * * SQL Data Type: datetimeoffset
30351
+ * * Description: Calculated timestamp of when this job should next execute based on the cron expression. Updated after each run. Used by scheduler to determine which jobs are due.
30352
+ */
30353
+ get NextRunAt(): Date | null;
30354
+ set NextRunAt(value: Date | null);
30355
+ /**
30356
+ * * Field Name: RunCount
30357
+ * * Display Name: Run Count
30358
+ * * SQL Data Type: int
30359
+ * * Default Value: 0
30360
+ * * Description: Total number of times this schedule has been executed, including both successful and failed runs.
30361
+ */
30362
+ get RunCount(): number;
30363
+ set RunCount(value: number);
30364
+ /**
30365
+ * * Field Name: SuccessCount
30366
+ * * Display Name: Success Count
30367
+ * * SQL Data Type: int
30368
+ * * Default Value: 0
30369
+ * * Description: Number of times this schedule has executed successfully (Success = true in ScheduledJobRun).
30370
+ */
30371
+ get SuccessCount(): number;
30372
+ set SuccessCount(value: number);
30373
+ /**
30374
+ * * Field Name: FailureCount
30375
+ * * Display Name: Failure Count
30376
+ * * SQL Data Type: int
30377
+ * * Default Value: 0
30378
+ * * Description: Number of times this schedule has executed but failed (Success = false in ScheduledJobRun).
30379
+ */
30380
+ get FailureCount(): number;
30381
+ set FailureCount(value: number);
30382
+ /**
30383
+ * * Field Name: NotifyOnSuccess
30384
+ * * Display Name: Notify On Success
30385
+ * * SQL Data Type: bit
30386
+ * * Default Value: 0
30387
+ * * Description: Whether to send notifications when the job completes successfully.
30388
+ */
30389
+ get NotifyOnSuccess(): boolean;
30390
+ set NotifyOnSuccess(value: boolean);
30391
+ /**
30392
+ * * Field Name: NotifyOnFailure
30393
+ * * Display Name: Notify On Failure
30394
+ * * SQL Data Type: bit
30395
+ * * Default Value: 1
30396
+ * * Description: Whether to send notifications when the job fails. Defaults to true for alerting on failures.
30397
+ */
30398
+ get NotifyOnFailure(): boolean;
30399
+ set NotifyOnFailure(value: boolean);
30400
+ /**
30401
+ * * Field Name: NotifyUserID
30402
+ * * Display Name: Notify User ID
30403
+ * * SQL Data Type: uniqueidentifier
30404
+ * * Related Entity/Foreign Key: Users (vwUsers.ID)
30405
+ * * Description: User to notify about job execution results. If NULL and notifications are enabled, falls back to OwnerUserID.
30406
+ */
30407
+ get NotifyUserID(): string | null;
30408
+ set NotifyUserID(value: string | null);
30409
+ /**
30410
+ * * Field Name: NotifyViaEmail
30411
+ * * Display Name: Notify Via Email
30412
+ * * SQL Data Type: bit
30413
+ * * Default Value: 0
30414
+ * * Description: Whether to send email notifications. Requires NotifyOnSuccess or NotifyOnFailure to also be enabled.
30415
+ */
30416
+ get NotifyViaEmail(): boolean;
30417
+ set NotifyViaEmail(value: boolean);
30418
+ /**
30419
+ * * Field Name: NotifyViaInApp
30420
+ * * Display Name: Notify Via In App
30421
+ * * SQL Data Type: bit
30422
+ * * Default Value: 1
30423
+ * * Description: Whether to send in-app notifications. Requires NotifyOnSuccess or NotifyOnFailure to also be enabled. Defaults to true.
30424
+ */
30425
+ get NotifyViaInApp(): boolean;
30426
+ set NotifyViaInApp(value: boolean);
30427
+ /**
30428
+ * * Field Name: LockToken
30429
+ * * Display Name: Lock Token
30430
+ * * SQL Data Type: uniqueidentifier
30431
+ * * Description: Unique token used for distributed locking across multiple server instances. Set when a server claims the job for execution. Prevents duplicate executions in multi-server environments.
30432
+ */
30433
+ get LockToken(): string | null;
30434
+ set LockToken(value: string | null);
30435
+ /**
30436
+ * * Field Name: LockedAt
30437
+ * * Display Name: Locked At
30438
+ * * SQL Data Type: datetimeoffset
30439
+ * * Description: Timestamp when the lock was acquired. Used with ExpectedCompletionAt to detect stale locks from crashed server instances.
30440
+ */
30441
+ get LockedAt(): Date | null;
30442
+ set LockedAt(value: Date | null);
30443
+ /**
30444
+ * * Field Name: LockedByInstance
30445
+ * * Display Name: Locked By Instance
30446
+ * * SQL Data Type: nvarchar(255)
30447
+ * * Description: Identifier of the server instance that currently holds the lock (e.g., "hostname-12345"). Used for troubleshooting and monitoring which server is executing which job.
30448
+ */
30449
+ get LockedByInstance(): string | null;
30450
+ set LockedByInstance(value: string | null);
30451
+ /**
30452
+ * * Field Name: ExpectedCompletionAt
30453
+ * * Display Name: Expected Completion At
30454
+ * * SQL Data Type: datetimeoffset
30455
+ * * Description: Expected completion time for the current execution. If current time exceeds this and lock still exists, the lock is considered stale and can be claimed by another instance. Handles crashed server cleanup.
30456
+ */
30457
+ get ExpectedCompletionAt(): Date | null;
30458
+ set ExpectedCompletionAt(value: Date | null);
30459
+ /**
30460
+ * * Field Name: ConcurrencyMode
30461
+ * * Display Name: Concurrency Mode
30462
+ * * SQL Data Type: nvarchar(20)
30463
+ * * Default Value: Skip
30464
+ * * Value List Type: List
30465
+ * * Possible Values
30466
+ * * Queue
30467
+ * * Concurrent
30468
+ * * Skip
30469
+ * * Description: Controls behavior when a new execution is scheduled while a previous execution is still running. Skip=do not start new execution (default), Queue=wait for current to finish then execute, Concurrent=allow multiple simultaneous executions.
30470
+ */
30471
+ get ConcurrencyMode(): 'Concurrent' | 'Queue' | 'Skip';
30472
+ set ConcurrencyMode(value: 'Concurrent' | 'Queue' | 'Skip');
30473
+ /**
30474
+ * * Field Name: __mj_CreatedAt
30475
+ * * Display Name: Created At
30476
+ * * SQL Data Type: datetimeoffset
30477
+ * * Default Value: getutcdate()
30478
+ */
30479
+ get __mj_CreatedAt(): Date;
30480
+ /**
30481
+ * * Field Name: __mj_UpdatedAt
30482
+ * * Display Name: Updated At
30483
+ * * SQL Data Type: datetimeoffset
30484
+ * * Default Value: getutcdate()
30485
+ */
30486
+ get __mj_UpdatedAt(): Date;
30487
+ /**
30488
+ * * Field Name: JobType
30489
+ * * Display Name: Job Type
30490
+ * * SQL Data Type: nvarchar(100)
30491
+ */
30492
+ get JobType(): string;
30493
+ /**
30494
+ * * Field Name: OwnerUser
30495
+ * * Display Name: Owner User
30496
+ * * SQL Data Type: nvarchar(100)
30497
+ */
30498
+ get OwnerUser(): string | null;
30499
+ /**
30500
+ * * Field Name: NotifyUser
30501
+ * * Display Name: Notify User
30502
+ * * SQL Data Type: nvarchar(100)
30503
+ */
30504
+ get NotifyUser(): string | null;
30505
+ }
29401
30506
  /**
29402
30507
  * MJ: Task Dependencies - strongly typed entity sub-class
29403
30508
  * * Schema: __mj