@memberjunction/core-entities 5.10.0 → 5.11.0

package/dist/generated/entity_subclasses.d.ts

@@ -296,7 +296,7 @@ export declare const MJActionParamSchema: z.ZodObject<{
     Name: z.ZodString;
     DefaultValue: z.ZodNullable<z.ZodString>;
     Type: z.ZodUnion<[z.ZodLiteral<"Both">, z.ZodLiteral<"Input">, z.ZodLiteral<"Output">]>;
-    ValueType: z.ZodUnion<[z.ZodLiteral<"BaseEntity Sub-Class">, z.ZodLiteral<"BaseEntity Sub-Class">, z.ZodLiteral<"Other">, z.ZodLiteral<"MediaOutput">, z.ZodLiteral<"Other">, z.ZodLiteral<"Scalar">, z.ZodLiteral<"Scalar">, z.ZodLiteral<"Simple Object">, z.ZodLiteral<"Simple Object">]>;
+    ValueType: z.ZodUnion<[z.ZodLiteral<"BaseEntity Sub-Class">, z.ZodLiteral<"BaseEntity Sub-Class">, z.ZodLiteral<"MediaOutput">, z.ZodLiteral<"Other">, z.ZodLiteral<"Other">, z.ZodLiteral<"Scalar">, z.ZodLiteral<"Scalar">, z.ZodLiteral<"Simple Object">, z.ZodLiteral<"Simple Object">]>;
     IsArray: z.ZodBoolean;
     Description: z.ZodNullable<z.ZodString>;
     IsRequired: z.ZodBoolean;
@@ -314,7 +314,7 @@ export declare const MJActionParamSchema: z.ZodObject<{
     Description?: string;
     DefaultValue?: string;
     Type?: "Both" | "Input" | "Output";
-    ValueType?: "BaseEntity Sub-Class" | "Other" | "MediaOutput" | "Scalar" | "Simple Object";
+    ValueType?: "BaseEntity Sub-Class" | "MediaOutput" | "Other" | "Scalar" | "Simple Object";
     IsArray?: boolean;
     IsRequired?: boolean;
     MediaModality?: "Audio" | "Image" | "Video";
@@ -328,7 +328,7 @@ export declare const MJActionParamSchema: z.ZodObject<{
     Description?: string;
     DefaultValue?: string;
     Type?: "Both" | "Input" | "Output";
-    ValueType?: "BaseEntity Sub-Class" | "Other" | "MediaOutput" | "Scalar" | "Simple Object";
+    ValueType?: "BaseEntity Sub-Class" | "MediaOutput" | "Other" | "Scalar" | "Simple Object";
     IsArray?: boolean;
     IsRequired?: boolean;
     MediaModality?: "Audio" | "Image" | "Video";
@@ -10310,6 +10310,7 @@ export declare const MJQuerySchema: z.ZodObject<{
     EmbeddingModelID: z.ZodNullable<z.ZodString>;
     CacheValidationSQL: z.ZodNullable<z.ZodString>;
     SQLDialectID: z.ZodString;
+    Reusable: z.ZodBoolean;
     Category: z.ZodNullable<z.ZodString>;
     EmbeddingModel: z.ZodNullable<z.ZodString>;
     SQLDialect: z.ZodString;
@@ -10339,6 +10340,7 @@ export declare const MJQuerySchema: z.ZodObject<{
     CacheMaxSize?: number;
     CacheValidationSQL?: string;
     SQLDialectID?: string;
+    Reusable?: boolean;
     SQLDialect?: string;
 }, {
     ID?: string;
@@ -10366,6 +10368,7 @@ export declare const MJQuerySchema: z.ZodObject<{
     CacheMaxSize?: number;
     CacheValidationSQL?: string;
     SQLDialectID?: string;
+    Reusable?: boolean;
     SQLDialect?: string;
 }>;
 export type MJQueryEntityType = z.infer<typeof MJQuerySchema>;
@@ -10419,6 +10422,47 @@ export declare const MJQueryCategorySchema: z.ZodObject<{
     CacheInheritanceEnabled?: boolean;
 }>;
 export type MJQueryCategoryEntityType = z.infer<typeof MJQueryCategorySchema>;
+/**
+ * zod schema definition for the entity MJ: Query Dependencies
+ */
+export declare const MJQueryDependencySchema: z.ZodObject<{
+    ID: z.ZodString;
+    QueryID: z.ZodString;
+    DependsOnQueryID: z.ZodString;
+    ReferencePath: z.ZodString;
+    Alias: z.ZodNullable<z.ZodString>;
+    ParameterMapping: z.ZodNullable<z.ZodString>;
+    DetectionMethod: z.ZodUnion<[z.ZodLiteral<"Auto">, z.ZodLiteral<"Manual">]>;
+    __mj_CreatedAt: z.ZodDate;
+    __mj_UpdatedAt: z.ZodDate;
+    Query: z.ZodString;
+    DependsOnQuery: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    ID?: string;
+    __mj_CreatedAt?: Date;
+    __mj_UpdatedAt?: Date;
+    QueryID?: string;
+    Query?: string;
+    DependsOnQueryID?: string;
+    ReferencePath?: string;
+    Alias?: string;
+    ParameterMapping?: string;
+    DetectionMethod?: "Manual" | "Auto";
+    DependsOnQuery?: string;
+}, {
+    ID?: string;
+    __mj_CreatedAt?: Date;
+    __mj_UpdatedAt?: Date;
+    QueryID?: string;
+    Query?: string;
+    DependsOnQueryID?: string;
+    ReferencePath?: string;
+    Alias?: string;
+    ParameterMapping?: string;
+    DetectionMethod?: "Manual" | "Auto";
+    DependsOnQuery?: string;
+}>;
+export type MJQueryDependencyEntityType = z.infer<typeof MJQueryDependencySchema>;
 /**
  * zod schema definition for the entity MJ: Query Entities
  */
@@ -14894,17 +14938,17 @@ export declare class MJActionParamEntity extends BaseEntity<MJActionParamEntityT
     * * Possible Values
     *   * BaseEntity Sub-Class
     *   * BaseEntity Sub-Class
-    *   * Other
     *   * MediaOutput
     *   * Other
+    *   * Other
     *   * Scalar
     *   * Scalar
     *   * Simple Object
     *   * Simple Object
     * * Description: Tracks the basic value type of the parameter, additional information can be provided in the Description field
     */
-    get ValueType(): 'BaseEntity Sub-Class' | 'BaseEntity Sub-Class' | 'Other' | 'MediaOutput' | 'Other' | 'Scalar' | 'Scalar' | 'Simple Object' | 'Simple Object';
-    set ValueType(value: 'BaseEntity Sub-Class' | 'BaseEntity Sub-Class' | 'Other' | 'MediaOutput' | 'Other' | 'Scalar' | 'Scalar' | 'Simple Object' | 'Simple Object');
+    get ValueType(): 'BaseEntity Sub-Class' | 'BaseEntity Sub-Class' | 'MediaOutput' | 'Other' | 'Other' | 'Scalar' | 'Scalar' | 'Simple Object' | 'Simple Object';
+    set ValueType(value: 'BaseEntity Sub-Class' | 'BaseEntity Sub-Class' | 'MediaOutput' | 'Other' | 'Other' | 'Scalar' | 'Scalar' | 'Simple Object' | 'Simple Object');
     /**
     * * Field Name: IsArray
     * * Display Name: Is Array
@@ -43455,6 +43499,15 @@ export declare class MJQueryEntity extends BaseEntity<MJQueryEntityType> {
     get SQLDialectID(): string;
     set SQLDialectID(value: string);
     /**
+    * * Field Name: Reusable
+    * * Display Name: Is Reusable
+    * * SQL Data Type: bit
+    * * Default Value: 0
+    * * 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.
+    */
+    get Reusable(): boolean;
+    set Reusable(value: boolean);
+    /**
     * * Field Name: Category
     * * Display Name: Category Name
     * * SQL Data Type: nvarchar(50)
@@ -43602,6 +43655,120 @@ export declare class MJQueryCategoryEntity extends BaseEntity<MJQueryCategoryEnt
     */
     get RootParentID(): string | null;
 }
+/**
+ * MJ: Query Dependencies - strongly typed entity sub-class
+ * * Schema: __mj
+ * * Base Table: QueryDependency
+ * * Base View: vwQueryDependencies
+ * * @description Tracks which queries reference other queries via composition syntax. Auto-populated by the query save pipeline.
+ * * Primary Key: ID
+ * @extends {BaseEntity}
+ * @class
+ * @public
+ */
+export declare class MJQueryDependencyEntity extends BaseEntity<MJQueryDependencyEntityType> {
+    /**
+    * Loads the MJ: Query Dependencies record from the database
+    * @param ID: string - primary key value to load the MJ: Query Dependencies record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof MJQueryDependencyEntity
+    * @method
+    * @override
+    */
+    Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
+    /**
+    * * Field Name: ID
+    * * Display Name: ID
+    * * SQL Data Type: uniqueidentifier
+    * * Default Value: newsequentialid()
+    */
+    get ID(): string;
+    set ID(value: string);
+    /**
+    * * Field Name: QueryID
+    * * Display Name: Query
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: MJ: Queries (vwQueries.ID)
+    * * Description: Foreign key to the query that contains the composition reference.
+    */
+    get QueryID(): string;
+    set QueryID(value: string);
+    /**
+    * * Field Name: DependsOnQueryID
+    * * Display Name: Depends On Query
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: MJ: Queries (vwQueries.ID)
+    * * Description: Foreign key to the referenced (depended-upon) query.
+    */
+    get DependsOnQueryID(): string;
+    set DependsOnQueryID(value: string);
+    /**
+    * * Field Name: ReferencePath
+    * * Display Name: Reference Path
+    * * SQL Data Type: nvarchar(500)
+    * * Description: The full composition reference path as written in the SQL.
+    */
+    get ReferencePath(): string;
+    set ReferencePath(value: string);
+    /**
+    * * Field Name: Alias
+    * * Display Name: Alias
+    * * SQL Data Type: nvarchar(100)
+    * * Description: SQL alias used for the composed CTE in the referencing query.
+    */
+    get Alias(): string | null;
+    set Alias(value: string | null);
+    /**
+    * * Field Name: ParameterMapping
+    * * Display Name: Parameter Mapping
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: JSON object mapping parameter names to values or pass-through parameter names.
+    */
+    get ParameterMapping(): string | null;
+    set ParameterMapping(value: string | null);
+    /**
+    * * Field Name: DetectionMethod
+    * * Display Name: Detection Method
+    * * SQL Data Type: nvarchar(20)
+    * * Default Value: Auto
+    * * Value List Type: List
+    * * Possible Values
+    *   * Auto
+    *   * Manual
+    * * Description: How the dependency was detected: Auto (parsed from SQL) or Manual (user-specified).
+    */
+    get DetectionMethod(): 'Auto' | 'Manual';
+    set DetectionMethod(value: 'Auto' | 'Manual');
+    /**
+    * * Field Name: __mj_CreatedAt
+    * * Display Name: Created At
+    * * SQL Data Type: datetimeoffset
+    * * Default Value: getutcdate()
+    */
+    get __mj_CreatedAt(): Date;
+    /**
+    * * Field Name: __mj_UpdatedAt
+    * * Display Name: Updated At
+    * * SQL Data Type: datetimeoffset
+    * * Default Value: getutcdate()
+    */
+    get __mj_UpdatedAt(): Date;
+    /**
+    * * Field Name: Query
+    * * Display Name: Source Query Name
+    * * SQL Data Type: nvarchar(255)
+    */
+    get Query(): string;
+    /**
+    * * Field Name: DependsOnQuery
+    * * Display Name: Target Query Name
+    * * SQL Data Type: nvarchar(255)
+    */
+    get DependsOnQuery(): string;
+}
 /**
  * MJ: Query Entities - strongly typed entity sub-class
  * * Schema: __mj