@memberjunction/core-entities 2.108.0 → 2.109.0

package/dist/generated/entity_subclasses.d.ts

@@ -4851,6 +4851,83 @@ export declare const AIAgentArtifactTypeSchema: z.ZodObject<{
     ArtifactType?: string;
 }>;
 export type AIAgentArtifactTypeEntityType = z.infer<typeof AIAgentArtifactTypeSchema>;
+/**
+ * zod schema definition for the entity MJ: AI Agent Data Sources
+ */
+export declare const AIAgentDataSourceSchema: z.ZodObject<{
+    ID: z.ZodString;
+    AgentID: z.ZodString;
+    Name: z.ZodString;
+    Description: z.ZodNullable<z.ZodString>;
+    SourceType: z.ZodUnion<[z.ZodLiteral<"RunQuery">, z.ZodLiteral<"RunView">]>;
+    EntityName: z.ZodNullable<z.ZodString>;
+    ExtraFilter: z.ZodNullable<z.ZodString>;
+    OrderBy: z.ZodNullable<z.ZodString>;
+    FieldsToRetrieve: z.ZodNullable<z.ZodString>;
+    ResultType: z.ZodNullable<z.ZodUnion<[z.ZodLiteral<"entity_object">, z.ZodLiteral<"simple">]>>;
+    QueryName: z.ZodNullable<z.ZodString>;
+    CategoryPath: z.ZodNullable<z.ZodString>;
+    Parameters: z.ZodNullable<z.ZodString>;
+    MaxRows: z.ZodNullable<z.ZodNumber>;
+    ExecutionOrder: z.ZodNumber;
+    Status: z.ZodUnion<[z.ZodLiteral<"Active">, z.ZodLiteral<"Disabled">]>;
+    CachePolicy: z.ZodUnion<[z.ZodLiteral<"None">, z.ZodLiteral<"PerAgent">, z.ZodLiteral<"PerRun">]>;
+    CacheTimeoutSeconds: z.ZodNullable<z.ZodNumber>;
+    DestinationType: z.ZodUnion<[z.ZodLiteral<"Context">, z.ZodLiteral<"Data">, z.ZodLiteral<"Payload">]>;
+    DestinationPath: z.ZodNullable<z.ZodString>;
+    __mj_CreatedAt: z.ZodDate;
+    __mj_UpdatedAt: z.ZodDate;
+    Agent: z.ZodNullable<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    ID?: string;
+    __mj_CreatedAt?: Date;
+    __mj_UpdatedAt?: Date;
+    Name?: string;
+    Description?: string;
+    Status?: "Active" | "Disabled";
+    AgentID?: string;
+    Agent?: string;
+    ExecutionOrder?: number;
+    Parameters?: string;
+    SourceType?: "RunQuery" | "RunView";
+    EntityName?: string;
+    ExtraFilter?: string;
+    OrderBy?: string;
+    FieldsToRetrieve?: string;
+    ResultType?: "entity_object" | "simple";
+    QueryName?: string;
+    CategoryPath?: string;
+    MaxRows?: number;
+    CachePolicy?: "None" | "PerAgent" | "PerRun";
+    CacheTimeoutSeconds?: number;
+    DestinationType?: "Context" | "Data" | "Payload";
+    DestinationPath?: string;
+}, {
+    ID?: string;
+    __mj_CreatedAt?: Date;
+    __mj_UpdatedAt?: Date;
+    Name?: string;
+    Description?: string;
+    Status?: "Active" | "Disabled";
+    AgentID?: string;
+    Agent?: string;
+    ExecutionOrder?: number;
+    Parameters?: string;
+    SourceType?: "RunQuery" | "RunView";
+    EntityName?: string;
+    ExtraFilter?: string;
+    OrderBy?: string;
+    FieldsToRetrieve?: string;
+    ResultType?: "entity_object" | "simple";
+    QueryName?: string;
+    CategoryPath?: string;
+    MaxRows?: number;
+    CachePolicy?: "None" | "PerAgent" | "PerRun";
+    CacheTimeoutSeconds?: number;
+    DestinationType?: "Context" | "Data" | "Payload";
+    DestinationPath?: string;
+}>;
+export type AIAgentDataSourceEntityType = z.infer<typeof AIAgentDataSourceSchema>;
 /**
  * zod schema definition for the entity MJ: AI Agent Permissions
  */
@@ -5141,6 +5218,7 @@ export declare const AIAgentRunSchema: z.ZodObject<{
     LastRunID?: string;
     ConversationID?: string;
     Conversation?: string;
+    Data?: string;
     CompletedAt?: Date;
     ParentRunID?: string;
     Result?: string;
@@ -5162,7 +5240,6 @@ export declare const AIAgentRunSchema: z.ZodObject<{
     TotalPromptIterations?: number;
     OverrideModelID?: string;
     OverrideVendorID?: string;
-    Data?: string;
     Verbose?: boolean;
     RunName?: string;
     ScheduledJobRunID?: string;
@@ -5190,6 +5267,7 @@ export declare const AIAgentRunSchema: z.ZodObject<{
     LastRunID?: string;
     ConversationID?: string;
     Conversation?: string;
+    Data?: string;
     CompletedAt?: Date;
     ParentRunID?: string;
     Result?: string;
@@ -5211,7 +5289,6 @@ export declare const AIAgentRunSchema: z.ZodObject<{
     TotalPromptIterations?: number;
     OverrideModelID?: string;
     OverrideVendorID?: string;
-    Data?: string;
     Verbose?: boolean;
     RunName?: string;
     ScheduledJobRunID?: string;
@@ -6077,6 +6154,53 @@ export declare const AIVendorSchema: z.ZodObject<{
     Description?: string;
 }>;
 export type AIVendorEntityType = z.infer<typeof AIVendorSchema>;
+/**
+ * zod schema definition for the entity MJ: Artifact Permissions
+ */
+export declare const ArtifactPermissionSchema: z.ZodObject<{
+    ID: z.ZodString;
+    ArtifactID: z.ZodString;
+    UserID: z.ZodString;
+    CanRead: z.ZodBoolean;
+    CanEdit: z.ZodBoolean;
+    CanDelete: z.ZodBoolean;
+    CanShare: z.ZodBoolean;
+    SharedByUserID: z.ZodNullable<z.ZodString>;
+    __mj_CreatedAt: z.ZodDate;
+    __mj_UpdatedAt: z.ZodDate;
+    Artifact: z.ZodString;
+    User: z.ZodString;
+    SharedByUser: z.ZodNullable<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    ID?: string;
+    __mj_CreatedAt?: Date;
+    __mj_UpdatedAt?: Date;
+    UserID?: string;
+    User?: string;
+    ArtifactID?: string;
+    Artifact?: string;
+    CanRead?: boolean;
+    CanDelete?: boolean;
+    CanShare?: boolean;
+    CanEdit?: boolean;
+    SharedByUserID?: string;
+    SharedByUser?: string;
+}, {
+    ID?: string;
+    __mj_CreatedAt?: Date;
+    __mj_UpdatedAt?: Date;
+    UserID?: string;
+    User?: string;
+    ArtifactID?: string;
+    Artifact?: string;
+    CanRead?: boolean;
+    CanDelete?: boolean;
+    CanShare?: boolean;
+    CanEdit?: boolean;
+    SharedByUserID?: string;
+    SharedByUser?: string;
+}>;
+export type ArtifactPermissionEntityType = z.infer<typeof ArtifactPermissionSchema>;
 /**
  * zod schema definition for the entity MJ: Artifact Types
  */
@@ -6309,10 +6433,10 @@ export declare const CollectionPermissionSchema: z.ZodObject<{
     CanDelete?: boolean;
     CanShare?: boolean;
     CanEdit?: boolean;
-    CollectionID?: string;
-    Collection?: string;
     SharedByUserID?: string;
     SharedByUser?: string;
+    CollectionID?: string;
+    Collection?: string;
 }, {
     ID?: string;
     __mj_CreatedAt?: Date;
@@ -6323,10 +6447,10 @@ export declare const CollectionPermissionSchema: z.ZodObject<{
     CanDelete?: boolean;
     CanShare?: boolean;
     CanEdit?: boolean;
-    CollectionID?: string;
-    Collection?: string;
     SharedByUserID?: string;
     SharedByUser?: string;
+    CollectionID?: string;
+    Collection?: string;
 }>;
 export type CollectionPermissionEntityType = z.infer<typeof CollectionPermissionSchema>;
 /**
@@ -8941,10 +9065,10 @@ export declare const TemplateParamSchema: z.ZodObject<{
     EntityID?: string;
     Entity?: string;
     RecordID?: string;
-    LinkedParameterName?: string;
-    LinkedParameterField?: string;
     ExtraFilter?: string;
     OrderBy?: string;
+    LinkedParameterName?: string;
+    LinkedParameterField?: string;
     TemplateContentID?: string;
 }, {
     ID?: string;
@@ -8960,10 +9084,10 @@ export declare const TemplateParamSchema: z.ZodObject<{
     EntityID?: string;
     Entity?: string;
     RecordID?: string;
-    LinkedParameterName?: string;
-    LinkedParameterField?: string;
     ExtraFilter?: string;
     OrderBy?: string;
+    LinkedParameterName?: string;
+    LinkedParameterField?: string;
     TemplateContentID?: string;
 }>;
 export type TemplateParamEntityType = z.infer<typeof TemplateParamSchema>;
@@ -11016,15 +11140,27 @@ export declare class AIAgentActionEntity extends BaseEntity<AIAgentActionEntityT
     Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
     /**
     * Validate() method override for AI Agent Actions entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
+    * * CompactLength: This rule ensures that if a value is provided for CompactLength, it must be greater than zero. If CompactLength is left empty, no rule applies.
     * * MaxExecutionsPerRun: This rule ensures that if the maximum executions per run is specified, the number must be greater than zero. If it is not specified, no restriction applies.
     * * MinExecutionsPerRun: This rule ensures that if a minimum executions per run value is provided, it must be zero or greater.
+    * * ResultExpirationTurns: This rule ensures that if the ResultExpirationTurns field has a value, it must be zero or greater (it cannot be negative). If ResultExpirationTurns is left empty, there is no restriction.
+    * * Table-Level: This rule ensures that if the compact mode is set to 'First N Chars', a compact length must be specified. For any other compact mode, the compact length can be left empty.
+    * * Table-Level: This rule ensures that if the result expiration mode is set to 'Compact', a compact mode value must also be provided. If the result expiration mode is not 'Compact', compact mode can be left empty.
     * * Table-Level: This rule ensures that if both minimum and maximum executions per run are specified, the minimum cannot be greater than the maximum. If either value is not specified, the rule is not enforced.
+    * * Table-Level: This rule ensures that if the result expiration mode is set to 'Compact', then CompactMode, CompactLength, and CompactPromptID must all be empty (null). If the expiration mode is not 'Compact', these fields may be filled in.
     * @public
     * @method
     * @override
     */
     Validate(): ValidationResult;
     /**
+    * This rule ensures that if a value is provided for CompactLength, it must be greater than zero. If CompactLength is left empty, no rule applies.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateCompactLengthGreaterThanZero(result: ValidationResult): void;
+    /**
     * This rule ensures that if the maximum executions per run is specified, the number must be greater than zero. If it is not specified, no restriction applies.
     * @param result - the ValidationResult object to add any errors or warnings to
     * @public
@@ -11039,6 +11175,27 @@ export declare class AIAgentActionEntity extends BaseEntity<AIAgentActionEntityT
     */
     ValidateMinExecutionsPerRunIsNonNegative(result: ValidationResult): void;
     /**
+    * This rule ensures that if the ResultExpirationTurns field has a value, it must be zero or greater (it cannot be negative). If ResultExpirationTurns is left empty, there is no restriction.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateResultExpirationTurnsNonNegative(result: ValidationResult): void;
+    /**
+    * This rule ensures that if the compact mode is set to 'First N Chars', a compact length must be specified. For any other compact mode, the compact length can be left empty.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateCompactLengthRequiredForFirstNCharsMode(result: ValidationResult): void;
+    /**
+    * This rule ensures that if the result expiration mode is set to 'Compact', a compact mode value must also be provided. If the result expiration mode is not 'Compact', compact mode can be left empty.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateCompactModeWhenResultExpirationModeIsCompact(result: ValidationResult): void;
+    /**
     * This rule ensures that if both minimum and maximum executions per run are specified, the minimum cannot be greater than the maximum. If either value is not specified, the rule is not enforced.
     * @param result - the ValidationResult object to add any errors or warnings to
     * @public
@@ -11046,6 +11203,13 @@ export declare class AIAgentActionEntity extends BaseEntity<AIAgentActionEntityT
     */
     ValidateMinExecutionsPerRunIsLessThanOrEqualToMaxExecutionsPerRun(result: ValidationResult): void;
     /**
+    * This rule ensures that if the result expiration mode is set to 'Compact', then CompactMode, CompactLength, and CompactPromptID must all be empty (null). If the expiration mode is not 'Compact', these fields may be filled in.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateResultExpirationModeRequiresCompactFieldsEmpty(result: ValidationResult): void;
+    /**
     * * Field Name: ID
     * * Display Name: ID
     * * SQL Data Type: uniqueidentifier
@@ -23279,6 +23443,270 @@ export declare class AIAgentArtifactTypeEntity extends BaseEntity<AIAgentArtifac
     */
     get ArtifactType(): string;
 }
+/**
+ * MJ: AI Agent Data Sources - strongly typed entity sub-class
+ * * Schema: __mj
+ * * Base Table: AIAgentDataSource
+ * * Base View: vwAIAgentDataSources
+ * * @description Defines data sources that should be preloaded into the data parameter before agent execution. Supports both RunView and RunQuery sources with configurable caching.
+ * * Primary Key: ID
+ * @extends {BaseEntity}
+ * @class
+ * @public
+ */
+export declare class AIAgentDataSourceEntity extends BaseEntity<AIAgentDataSourceEntityType> {
+    /**
+    * Loads the MJ: AI Agent Data Sources record from the database
+    * @param ID: string - primary key value to load the MJ: AI Agent Data Sources record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof AIAgentDataSourceEntity
+    * @method
+    * @override
+    */
+    Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
+    /**
+    * Validate() method override for MJ: AI Agent Data Sources entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
+    * * Table-Level: This rule ensures that if the cache policy is set to 'PerAgent', a cache timeout value must be provided. For other cache policies, providing a cache timeout is optional.
+    * * Table-Level: This rule makes sure that if the source type is 'RunView', the entity name must be provided. If the source type is anything else, the entity name can be left blank.
+    * * Table-Level: This rule ensures that when the Source Type is set to 'RunQuery', a Query Name must be provided. If Source Type is anything other than 'RunQuery', Query Name is optional.
+    * @public
+    * @method
+    * @override
+    */
+    Validate(): ValidationResult;
+    /**
+    * This rule ensures that if the cache policy is set to 'PerAgent', a cache timeout value must be provided. For other cache policies, providing a cache timeout is optional.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateCacheTimeoutSecondsRequiredForPerAgentPolicy(result: ValidationResult): void;
+    /**
+    * This rule makes sure that if the source type is 'RunView', the entity name must be provided. If the source type is anything else, the entity name can be left blank.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateEntityNameRequiredWhenSourceTypeRunView(result: ValidationResult): void;
+    /**
+    * This rule ensures that when the Source Type is set to 'RunQuery', a Query Name must be provided. If Source Type is anything other than 'RunQuery', Query Name is optional.
+    * @param result - the ValidationResult object to add any errors or warnings to
+    * @public
+    * @method
+    */
+    ValidateQueryNameRequiredWhenSourceTypeIsRunQuery(result: ValidationResult): void;
+    /**
+    * * Field Name: ID
+    * * Display Name: ID
+    * * SQL Data Type: uniqueidentifier
+    * * Default Value: newsequentialid()
+    */
+    get ID(): string;
+    set ID(value: string);
+    /**
+    * * Field Name: AgentID
+    * * Display Name: Agent ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: AI Agents (vwAIAgents.ID)
+    */
+    get AgentID(): string;
+    set AgentID(value: string);
+    /**
+    * * Field Name: Name
+    * * Display Name: Name
+    * * SQL Data Type: nvarchar(255)
+    * * Description: Variable name for the data in the data parameter (e.g., "ALL_ENTITIES"). Must be unique within an agent.
+    */
+    get Name(): string;
+    set Name(value: string);
+    /**
+    * * Field Name: Description
+    * * Display Name: Description
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: Description of what this data source provides
+    */
+    get Description(): string | null;
+    set Description(value: string | null);
+    /**
+    * * Field Name: SourceType
+    * * Display Name: Source Type
+    * * SQL Data Type: nvarchar(20)
+    * * Default Value: RunView
+    * * Value List Type: List
+    * * Possible Values
+    *   * RunQuery
+    *   * RunView
+    * * Description: Type of data source: RunView or RunQuery. Determines which parameters are used.
+    */
+    get SourceType(): 'RunQuery' | 'RunView';
+    set SourceType(value: 'RunQuery' | 'RunView');
+    /**
+    * * Field Name: EntityName
+    * * Display Name: Entity Name
+    * * SQL Data Type: nvarchar(255)
+    * * Description: Entity name for RunView data sources (e.g., "Entities", "AI Models")
+    */
+    get EntityName(): string | null;
+    set EntityName(value: string | null);
+    /**
+    * * Field Name: ExtraFilter
+    * * Display Name: Extra Filter
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: SQL WHERE clause filter for RunView data sources
+    */
+    get ExtraFilter(): string | null;
+    set ExtraFilter(value: string | null);
+    /**
+    * * Field Name: OrderBy
+    * * Display Name: Order By
+    * * SQL Data Type: nvarchar(500)
+    * * Description: SQL ORDER BY clause for RunView data sources
+    */
+    get OrderBy(): string | null;
+    set OrderBy(value: string | null);
+    /**
+    * * Field Name: FieldsToRetrieve
+    * * Display Name: Fields To Retrieve
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: JSON array of field names to return for RunView data sources (e.g., ["ID", "Name", "Description"])
+    */
+    get FieldsToRetrieve(): string | null;
+    set FieldsToRetrieve(value: string | null);
+    /**
+    * * Field Name: ResultType
+    * * Display Name: Result Type
+    * * SQL Data Type: nvarchar(20)
+    * * Default Value: simple
+    * * Value List Type: List
+    * * Possible Values
+    *   * entity_object
+    *   * simple
+    * * Description: Result type for RunView: simple (default) or entity_object
+    */
+    get ResultType(): 'entity_object' | 'simple' | null;
+    set ResultType(value: 'entity_object' | 'simple' | null);
+    /**
+    * * Field Name: QueryName
+    * * Display Name: Query Name
+    * * SQL Data Type: nvarchar(255)
+    * * Description: Query name for RunQuery data sources
+    */
+    get QueryName(): string | null;
+    set QueryName(value: string | null);
+    /**
+    * * Field Name: CategoryPath
+    * * Display Name: Category Path
+    * * SQL Data Type: nvarchar(500)
+    * * Description: Category path for RunQuery data sources (e.g., "/MJ/AI/Agents/")
+    */
+    get CategoryPath(): string | null;
+    set CategoryPath(value: string | null);
+    /**
+    * * Field Name: Parameters
+    * * Display Name: Parameters
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: JSON object of parameters for RunQuery data sources (e.g., {"organizationId": "123"})
+    */
+    get Parameters(): string | null;
+    set Parameters(value: string | null);
+    /**
+    * * Field Name: MaxRows
+    * * Display Name: Max Rows
+    * * SQL Data Type: int
+    * * Description: Maximum number of rows to return. Applies to both RunView and RunQuery.
+    */
+    get MaxRows(): number | null;
+    set MaxRows(value: number | null);
+    /**
+    * * Field Name: ExecutionOrder
+    * * Display Name: Execution Order
+    * * SQL Data Type: int
+    * * Default Value: 0
+    * * Description: Execution order when multiple data sources are defined for an agent (lower numbers execute first)
+    */
+    get ExecutionOrder(): number;
+    set ExecutionOrder(value: number);
+    /**
+    * * Field Name: Status
+    * * Display Name: Status
+    * * SQL Data Type: nvarchar(20)
+    * * Default Value: Active
+    * * Value List Type: List
+    * * Possible Values
+    *   * Active
+    *   * Disabled
+    * * Description: Status of the data source: Active or Disabled
+    */
+    get Status(): 'Active' | 'Disabled';
+    set Status(value: 'Active' | 'Disabled');
+    /**
+    * * Field Name: CachePolicy
+    * * Display Name: Cache Policy
+    * * SQL Data Type: nvarchar(20)
+    * * Default Value: None
+    * * Value List Type: List
+    * * Possible Values
+    *   * PerRun
+    *   * PerAgent
+    *   * None
+    * * Description: Cache policy: None (no caching), PerRun (cache for duration of agent run), PerAgent (cache across runs with timeout)
+    */
+    get CachePolicy(): 'None' | 'PerAgent' | 'PerRun';
+    set CachePolicy(value: 'None' | 'PerAgent' | 'PerRun');
+    /**
+    * * Field Name: CacheTimeoutSeconds
+    * * Display Name: Cache Timeout Seconds
+    * * SQL Data Type: int
+    * * Description: Time-to-live in seconds for PerAgent cache policy. Ignored for other cache policies.
+    */
+    get CacheTimeoutSeconds(): number | null;
+    set CacheTimeoutSeconds(value: number | null);
+    /**
+    * * Field Name: DestinationType
+    * * Display Name: Destination Type
+    * * SQL Data Type: nvarchar(20)
+    * * Default Value: Data
+    * * Value List Type: List
+    * * Possible Values
+    *   * Data
+    *   * Context
+    *   * Payload
+    * * Description: Destination for the preloaded data: Data (for Nunjucks templates in prompts), Context (for actions only), or Payload (for agent state)
+    */
+    get DestinationType(): 'Context' | 'Data' | 'Payload';
+    set DestinationType(value: 'Context' | 'Data' | 'Payload');
+    /**
+    * * Field Name: DestinationPath
+    * * Display Name: Destination Path
+    * * SQL Data Type: nvarchar(500)
+    * * Description: Path within the destination where data should be injected. Supports nested paths using dot notation (e.g., "config.api.endpoints", "analysis.orders.recent"). If null, uses Name as root-level key.
+    */
+    get DestinationPath(): string | null;
+    set DestinationPath(value: string | null);
+    /**
+    * * 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: Agent
+    * * Display Name: Agent
+    * * SQL Data Type: nvarchar(255)
+    */
+    get Agent(): string | null;
+}
 /**
  * MJ: AI Agent Permissions - strongly typed entity sub-class
  * * Schema: __mj
@@ -27001,6 +27429,132 @@ export declare class AIVendorEntity extends BaseEntity<AIVendorEntityType> {
     */
     get __mj_UpdatedAt(): Date;
 }
+/**
+ * MJ: Artifact Permissions - strongly typed entity sub-class
+ * * Schema: __mj
+ * * Base Table: ArtifactPermission
+ * * Base View: vwArtifactPermissions
+ * * @description Manages user permissions for artifacts with granular access control (Read, Edit, Delete, Share)
+ * * Primary Key: ID
+ * @extends {BaseEntity}
+ * @class
+ * @public
+ */
+export declare class ArtifactPermissionEntity extends BaseEntity<ArtifactPermissionEntityType> {
+    /**
+    * Loads the MJ: Artifact Permissions record from the database
+    * @param ID: string - primary key value to load the MJ: Artifact Permissions record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof ArtifactPermissionEntity
+    * @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: ArtifactID
+    * * Display Name: Artifact ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: MJ: Artifacts (vwArtifacts.ID)
+    */
+    get ArtifactID(): string;
+    set ArtifactID(value: string);
+    /**
+    * * Field Name: UserID
+    * * Display Name: User ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: Users (vwUsers.ID)
+    */
+    get UserID(): string;
+    set UserID(value: string);
+    /**
+    * * Field Name: CanRead
+    * * Display Name: Can Read
+    * * SQL Data Type: bit
+    * * Default Value: 1
+    * * Description: Whether the user can view/read the artifact
+    */
+    get CanRead(): boolean;
+    set CanRead(value: boolean);
+    /**
+    * * Field Name: CanEdit
+    * * Display Name: Can Edit
+    * * SQL Data Type: bit
+    * * Default Value: 0
+    * * Description: Whether the user can modify the artifact or create new versions
+    */
+    get CanEdit(): boolean;
+    set CanEdit(value: boolean);
+    /**
+    * * Field Name: CanDelete
+    * * Display Name: Can Delete
+    * * SQL Data Type: bit
+    * * Default Value: 0
+    * * Description: Whether the user can delete the artifact
+    */
+    get CanDelete(): boolean;
+    set CanDelete(value: boolean);
+    /**
+    * * Field Name: CanShare
+    * * Display Name: Can Share
+    * * SQL Data Type: bit
+    * * Default Value: 0
+    * * Description: Whether the user can share the artifact with other users
+    */
+    get CanShare(): boolean;
+    set CanShare(value: boolean);
+    /**
+    * * Field Name: SharedByUserID
+    * * Display Name: Shared By User ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: Users (vwUsers.ID)
+    * * Description: Foreign key to the User who shared this artifact (if shared)
+    */
+    get SharedByUserID(): string | null;
+    set SharedByUserID(value: string | null);
+    /**
+    * * 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: Artifact
+    * * Display Name: Artifact
+    * * SQL Data Type: nvarchar(255)
+    */
+    get Artifact(): string;
+    /**
+    * * Field Name: User
+    * * Display Name: User
+    * * SQL Data Type: nvarchar(100)
+    */
+    get User(): string;
+    /**
+    * * Field Name: SharedByUser
+    * * Display Name: Shared By User
+    * * SQL Data Type: nvarchar(100)
+    */
+    get SharedByUser(): string | null;
+}
 /**
  * MJ: Artifact Types - strongly typed entity sub-class
  * * Schema: __mj