@memberjunction/core-entities 5.10.0 → 5.11.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.
@@ -463,7 +463,7 @@ export const MJActionParamSchema = z.object({
463
463
  * * Input
464
464
  * * Output
465
465
  * * Description: Specifies whether this parameter is used for Input, Output, or Both directions in the action execution flow.`),
466
- ValueType: z.union([z.literal('BaseEntity Sub-Class'), z.literal('BaseEntity Sub-Class'), z.literal('Other'), z.literal('MediaOutput'), z.literal('Other'), z.literal('Scalar'), z.literal('Scalar'), z.literal('Simple Object'), z.literal('Simple Object')]).describe(`
466
+ ValueType: z.union([z.literal('BaseEntity Sub-Class'), z.literal('BaseEntity Sub-Class'), z.literal('MediaOutput'), z.literal('Other'), z.literal('Other'), z.literal('Scalar'), z.literal('Scalar'), z.literal('Simple Object'), z.literal('Simple Object')]).describe(`
467
467
  * * Field Name: ValueType
468
468
  * * Display Name: Value Type
469
469
  * * SQL Data Type: nvarchar(30)
@@ -471,9 +471,9 @@ export const MJActionParamSchema = z.object({
471
471
  * * Possible Values
472
472
  * * BaseEntity Sub-Class
473
473
  * * BaseEntity Sub-Class
474
- * * Other
475
474
  * * MediaOutput
476
475
  * * Other
476
+ * * Other
477
477
  * * Scalar
478
478
  * * Scalar
479
479
  * * Simple Object
@@ -16547,6 +16547,12 @@ export const MJQuerySchema = z.object({
16547
16547
  * * Related Entity/Foreign Key: MJ: SQL Dialects (vwSQLDialects.ID)
16548
16548
  * * Default Value: 1F203987-A37B-4BC1-85B3-BA50DC33C3E0
16549
16549
  * * Description: The SQL dialect that the SQL column is written in. Defaults to T-SQL for backward compatibility.`),
16550
+ Reusable: z.boolean().describe(`
16551
+ * * Field Name: Reusable
16552
+ * * Display Name: Is Reusable
16553
+ * * SQL Data Type: bit
16554
+ * * Default Value: 0
16555
+ * * Description: When true, this query can be referenced by other queries using composition syntax. Only queries that are both Reusable and Approved can be composed into other queries.`),
16550
16556
  Category: z.string().nullable().describe(`
16551
16557
  * * Field Name: Category
16552
16558
  * * Display Name: Category Name
@@ -16632,6 +16638,71 @@ export const MJQueryCategorySchema = z.object({
16632
16638
  * * Display Name: Root Parent ID
16633
16639
  * * SQL Data Type: uniqueidentifier`),
16634
16640
  });
16641
+ /**
16642
+ * zod schema definition for the entity MJ: Query Dependencies
16643
+ */
16644
+ export const MJQueryDependencySchema = z.object({
16645
+ ID: z.string().describe(`
16646
+ * * Field Name: ID
16647
+ * * Display Name: ID
16648
+ * * SQL Data Type: uniqueidentifier
16649
+ * * Default Value: newsequentialid()`),
16650
+ QueryID: z.string().describe(`
16651
+ * * Field Name: QueryID
16652
+ * * Display Name: Query
16653
+ * * SQL Data Type: uniqueidentifier
16654
+ * * Related Entity/Foreign Key: MJ: Queries (vwQueries.ID)
16655
+ * * Description: Foreign key to the query that contains the composition reference.`),
16656
+ DependsOnQueryID: z.string().describe(`
16657
+ * * Field Name: DependsOnQueryID
16658
+ * * Display Name: Depends On Query
16659
+ * * SQL Data Type: uniqueidentifier
16660
+ * * Related Entity/Foreign Key: MJ: Queries (vwQueries.ID)
16661
+ * * Description: Foreign key to the referenced (depended-upon) query.`),
16662
+ ReferencePath: z.string().describe(`
16663
+ * * Field Name: ReferencePath
16664
+ * * Display Name: Reference Path
16665
+ * * SQL Data Type: nvarchar(500)
16666
+ * * Description: The full composition reference path as written in the SQL.`),
16667
+ Alias: z.string().nullable().describe(`
16668
+ * * Field Name: Alias
16669
+ * * Display Name: Alias
16670
+ * * SQL Data Type: nvarchar(100)
16671
+ * * Description: SQL alias used for the composed CTE in the referencing query.`),
16672
+ ParameterMapping: z.string().nullable().describe(`
16673
+ * * Field Name: ParameterMapping
16674
+ * * Display Name: Parameter Mapping
16675
+ * * SQL Data Type: nvarchar(MAX)
16676
+ * * Description: JSON object mapping parameter names to values or pass-through parameter names.`),
16677
+ DetectionMethod: z.union([z.literal('Auto'), z.literal('Manual')]).describe(`
16678
+ * * Field Name: DetectionMethod
16679
+ * * Display Name: Detection Method
16680
+ * * SQL Data Type: nvarchar(20)
16681
+ * * Default Value: Auto
16682
+ * * Value List Type: List
16683
+ * * Possible Values
16684
+ * * Auto
16685
+ * * Manual
16686
+ * * Description: How the dependency was detected: Auto (parsed from SQL) or Manual (user-specified).`),
16687
+ __mj_CreatedAt: z.date().describe(`
16688
+ * * Field Name: __mj_CreatedAt
16689
+ * * Display Name: Created At
16690
+ * * SQL Data Type: datetimeoffset
16691
+ * * Default Value: getutcdate()`),
16692
+ __mj_UpdatedAt: z.date().describe(`
16693
+ * * Field Name: __mj_UpdatedAt
16694
+ * * Display Name: Updated At
16695
+ * * SQL Data Type: datetimeoffset
16696
+ * * Default Value: getutcdate()`),
16697
+ Query: z.string().describe(`
16698
+ * * Field Name: Query
16699
+ * * Display Name: Source Query Name
16700
+ * * SQL Data Type: nvarchar(255)`),
16701
+ DependsOnQuery: z.string().describe(`
16702
+ * * Field Name: DependsOnQuery
16703
+ * * Display Name: Target Query Name
16704
+ * * SQL Data Type: nvarchar(255)`),
16705
+ });
16635
16706
  /**
16636
16707
  * zod schema definition for the entity MJ: Query Entities
16637
16708
  */
@@ -23309,9 +23380,9 @@ let MJActionParamEntity = class MJActionParamEntity extends BaseEntity {
23309
23380
  * * Possible Values
23310
23381
  * * BaseEntity Sub-Class
23311
23382
  * * BaseEntity Sub-Class
23312
- * * Other
23313
23383
  * * MediaOutput
23314
23384
  * * Other
23385
+ * * Other
23315
23386
  * * Scalar
23316
23387
  * * Scalar
23317
23388
  * * Simple Object
@@ -63946,6 +64017,19 @@ let MJQueryEntity = class MJQueryEntity extends BaseEntity {
63946
64017
  this.Set('SQLDialectID', value);
63947
64018
  }
63948
64019
  /**
64020
+ * * Field Name: Reusable
64021
+ * * Display Name: Is Reusable
64022
+ * * SQL Data Type: bit
64023
+ * * Default Value: 0
64024
+ * * Description: When true, this query can be referenced by other queries using composition syntax. Only queries that are both Reusable and Approved can be composed into other queries.
64025
+ */
64026
+ get Reusable() {
64027
+ return this.Get('Reusable');
64028
+ }
64029
+ set Reusable(value) {
64030
+ this.Set('Reusable', value);
64031
+ }
64032
+ /**
63949
64033
  * * Field Name: Category
63950
64034
  * * Display Name: Category Name
63951
64035
  * * SQL Data Type: nvarchar(50)
@@ -64157,6 +64241,164 @@ MJQueryCategoryEntity = __decorate([
64157
64241
  RegisterClass(BaseEntity, 'MJ: Query Categories')
64158
64242
  ], MJQueryCategoryEntity);
64159
64243
  export { MJQueryCategoryEntity };
64244
+ /**
64245
+ * MJ: Query Dependencies - strongly typed entity sub-class
64246
+ * * Schema: __mj
64247
+ * * Base Table: QueryDependency
64248
+ * * Base View: vwQueryDependencies
64249
+ * * @description Tracks which queries reference other queries via composition syntax. Auto-populated by the query save pipeline.
64250
+ * * Primary Key: ID
64251
+ * @extends {BaseEntity}
64252
+ * @class
64253
+ * @public
64254
+ */
64255
+ let MJQueryDependencyEntity = class MJQueryDependencyEntity extends BaseEntity {
64256
+ /**
64257
+ * Loads the MJ: Query Dependencies record from the database
64258
+ * @param ID: string - primary key value to load the MJ: Query Dependencies record.
64259
+ * @param EntityRelationshipsToLoad - (optional) the relationships to load
64260
+ * @returns {Promise<boolean>} - true if successful, false otherwise
64261
+ * @public
64262
+ * @async
64263
+ * @memberof MJQueryDependencyEntity
64264
+ * @method
64265
+ * @override
64266
+ */
64267
+ async Load(ID, EntityRelationshipsToLoad) {
64268
+ const compositeKey = new CompositeKey();
64269
+ compositeKey.KeyValuePairs.push({ FieldName: 'ID', Value: ID });
64270
+ return await super.InnerLoad(compositeKey, EntityRelationshipsToLoad);
64271
+ }
64272
+ /**
64273
+ * * Field Name: ID
64274
+ * * Display Name: ID
64275
+ * * SQL Data Type: uniqueidentifier
64276
+ * * Default Value: newsequentialid()
64277
+ */
64278
+ get ID() {
64279
+ return this.Get('ID');
64280
+ }
64281
+ set ID(value) {
64282
+ this.Set('ID', value);
64283
+ }
64284
+ /**
64285
+ * * Field Name: QueryID
64286
+ * * Display Name: Query
64287
+ * * SQL Data Type: uniqueidentifier
64288
+ * * Related Entity/Foreign Key: MJ: Queries (vwQueries.ID)
64289
+ * * Description: Foreign key to the query that contains the composition reference.
64290
+ */
64291
+ get QueryID() {
64292
+ return this.Get('QueryID');
64293
+ }
64294
+ set QueryID(value) {
64295
+ this.Set('QueryID', value);
64296
+ }
64297
+ /**
64298
+ * * Field Name: DependsOnQueryID
64299
+ * * Display Name: Depends On Query
64300
+ * * SQL Data Type: uniqueidentifier
64301
+ * * Related Entity/Foreign Key: MJ: Queries (vwQueries.ID)
64302
+ * * Description: Foreign key to the referenced (depended-upon) query.
64303
+ */
64304
+ get DependsOnQueryID() {
64305
+ return this.Get('DependsOnQueryID');
64306
+ }
64307
+ set DependsOnQueryID(value) {
64308
+ this.Set('DependsOnQueryID', value);
64309
+ }
64310
+ /**
64311
+ * * Field Name: ReferencePath
64312
+ * * Display Name: Reference Path
64313
+ * * SQL Data Type: nvarchar(500)
64314
+ * * Description: The full composition reference path as written in the SQL.
64315
+ */
64316
+ get ReferencePath() {
64317
+ return this.Get('ReferencePath');
64318
+ }
64319
+ set ReferencePath(value) {
64320
+ this.Set('ReferencePath', value);
64321
+ }
64322
+ /**
64323
+ * * Field Name: Alias
64324
+ * * Display Name: Alias
64325
+ * * SQL Data Type: nvarchar(100)
64326
+ * * Description: SQL alias used for the composed CTE in the referencing query.
64327
+ */
64328
+ get Alias() {
64329
+ return this.Get('Alias');
64330
+ }
64331
+ set Alias(value) {
64332
+ this.Set('Alias', value);
64333
+ }
64334
+ /**
64335
+ * * Field Name: ParameterMapping
64336
+ * * Display Name: Parameter Mapping
64337
+ * * SQL Data Type: nvarchar(MAX)
64338
+ * * Description: JSON object mapping parameter names to values or pass-through parameter names.
64339
+ */
64340
+ get ParameterMapping() {
64341
+ return this.Get('ParameterMapping');
64342
+ }
64343
+ set ParameterMapping(value) {
64344
+ this.Set('ParameterMapping', value);
64345
+ }
64346
+ /**
64347
+ * * Field Name: DetectionMethod
64348
+ * * Display Name: Detection Method
64349
+ * * SQL Data Type: nvarchar(20)
64350
+ * * Default Value: Auto
64351
+ * * Value List Type: List
64352
+ * * Possible Values
64353
+ * * Auto
64354
+ * * Manual
64355
+ * * Description: How the dependency was detected: Auto (parsed from SQL) or Manual (user-specified).
64356
+ */
64357
+ get DetectionMethod() {
64358
+ return this.Get('DetectionMethod');
64359
+ }
64360
+ set DetectionMethod(value) {
64361
+ this.Set('DetectionMethod', value);
64362
+ }
64363
+ /**
64364
+ * * Field Name: __mj_CreatedAt
64365
+ * * Display Name: Created At
64366
+ * * SQL Data Type: datetimeoffset
64367
+ * * Default Value: getutcdate()
64368
+ */
64369
+ get __mj_CreatedAt() {
64370
+ return this.Get('__mj_CreatedAt');
64371
+ }
64372
+ /**
64373
+ * * Field Name: __mj_UpdatedAt
64374
+ * * Display Name: Updated At
64375
+ * * SQL Data Type: datetimeoffset
64376
+ * * Default Value: getutcdate()
64377
+ */
64378
+ get __mj_UpdatedAt() {
64379
+ return this.Get('__mj_UpdatedAt');
64380
+ }
64381
+ /**
64382
+ * * Field Name: Query
64383
+ * * Display Name: Source Query Name
64384
+ * * SQL Data Type: nvarchar(255)
64385
+ */
64386
+ get Query() {
64387
+ return this.Get('Query');
64388
+ }
64389
+ /**
64390
+ * * Field Name: DependsOnQuery
64391
+ * * Display Name: Target Query Name
64392
+ * * SQL Data Type: nvarchar(255)
64393
+ */
64394
+ get DependsOnQuery() {
64395
+ return this.Get('DependsOnQuery');
64396
+ }
64397
+ };
64398
+ MJQueryDependencyEntity = __decorate([
64399
+ RegisterClass(BaseEntity, 'MJ: Query Dependencies')
64400
+ ], MJQueryDependencyEntity);
64401
+ export { MJQueryDependencyEntity };
64160
64402
  /**
64161
64403
  * MJ: Query Entities - strongly typed entity sub-class
64162
64404
  * * Schema: __mj