@memberjunction/core-entities 6.1.0-edge.3 → 6.1.0-edge.4

package/dist/generated/entity_subclasses.d.ts

@@ -12185,6 +12185,100 @@ export declare const MJGeneratedCodeSchema: z.ZodObject<{
     GeneratedByModel?: string;
 }>;
 export type MJGeneratedCodeEntityType = z.infer<typeof MJGeneratedCodeSchema>;
+/**
+ * zod schema definition for the entity MJ: Identity Claim Types
+ */
+export declare const MJIdentityClaimTypeSchema: z.ZodObject<{
+    ID: z.ZodString;
+    Name: z.ZodString;
+    Description: z.ZodNullable<z.ZodString>;
+    DriverClass: z.ZodString;
+    Configuration: z.ZodNullable<z.ZodString>;
+    DefaultExpirationDays: z.ZodNumber;
+    IsActive: z.ZodBoolean;
+    __mj_CreatedAt: z.ZodDate;
+    __mj_UpdatedAt: z.ZodDate;
+}, "strip", z.ZodTypeAny, {
+    ID?: string;
+    __mj_CreatedAt?: Date;
+    __mj_UpdatedAt?: Date;
+    Name?: string;
+    Description?: string;
+    DriverClass?: string;
+    IsActive?: boolean;
+    Configuration?: string;
+    DefaultExpirationDays?: number;
+}, {
+    ID?: string;
+    __mj_CreatedAt?: Date;
+    __mj_UpdatedAt?: Date;
+    Name?: string;
+    Description?: string;
+    DriverClass?: string;
+    IsActive?: boolean;
+    Configuration?: string;
+    DefaultExpirationDays?: number;
+}>;
+export type MJIdentityClaimTypeEntityType = z.infer<typeof MJIdentityClaimTypeSchema>;
+/**
+ * zod schema definition for the entity MJ: Identity Claims
+ */
+export declare const MJIdentityClaimSchema: z.ZodObject<{
+    ID: z.ZodString;
+    ClaimTypeID: z.ZodString;
+    NormalizedEmail: z.ZodString;
+    EntityID: z.ZodNullable<z.ZodString>;
+    RecordID: z.ZodNullable<z.ZodString>;
+    PayloadJSON: z.ZodNullable<z.ZodString>;
+    Status: z.ZodUnion<[z.ZodLiteral<"Claimed">, z.ZodLiteral<"Expired">, z.ZodLiteral<"Pending">, z.ZodLiteral<"Revoked">]>;
+    ExpiresAt: z.ZodDate;
+    ClaimedAt: z.ZodNullable<z.ZodDate>;
+    ClaimedByUserID: z.ZodNullable<z.ZodString>;
+    MagicLinkInviteID: z.ZodNullable<z.ZodString>;
+    MetadataJSON: z.ZodNullable<z.ZodString>;
+    __mj_CreatedAt: z.ZodDate;
+    __mj_UpdatedAt: z.ZodDate;
+    ClaimType: z.ZodString;
+    Entity: z.ZodNullable<z.ZodString>;
+    ClaimedByUser: z.ZodNullable<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    ID?: string;
+    EntityID?: string;
+    RecordID?: string;
+    ExpiresAt?: Date;
+    __mj_CreatedAt?: Date;
+    __mj_UpdatedAt?: Date;
+    Entity?: string;
+    Status?: "Pending" | "Revoked" | "Expired" | "Claimed";
+    ClaimTypeID?: string;
+    NormalizedEmail?: string;
+    PayloadJSON?: string;
+    ClaimedAt?: Date;
+    ClaimedByUserID?: string;
+    MagicLinkInviteID?: string;
+    MetadataJSON?: string;
+    ClaimType?: string;
+    ClaimedByUser?: string;
+}, {
+    ID?: string;
+    EntityID?: string;
+    RecordID?: string;
+    ExpiresAt?: Date;
+    __mj_CreatedAt?: Date;
+    __mj_UpdatedAt?: Date;
+    Entity?: string;
+    Status?: "Pending" | "Revoked" | "Expired" | "Claimed";
+    ClaimTypeID?: string;
+    NormalizedEmail?: string;
+    PayloadJSON?: string;
+    ClaimedAt?: Date;
+    ClaimedByUserID?: string;
+    MagicLinkInviteID?: string;
+    MetadataJSON?: string;
+    ClaimType?: string;
+    ClaimedByUser?: string;
+}>;
+export type MJIdentityClaimEntityType = z.infer<typeof MJIdentityClaimSchema>;
 /**
  * zod schema definition for the entity MJ: Instance Configurations
  */
@@ -14020,6 +14114,7 @@ export declare const MJOAuthAuthServerMetadataCacheSchema: z.ZodObject<{
     ExpiresAt?: Date;
     __mj_CreatedAt?: Date;
     __mj_UpdatedAt?: Date;
+    MetadataJSON?: string;
     IssuerURL?: string;
     AuthorizationEndpoint?: string;
     TokenEndpoint?: string;
@@ -14031,13 +14126,13 @@ export declare const MJOAuthAuthServerMetadataCacheSchema: z.ZodObject<{
     GrantTypesSupported?: string;
     TokenEndpointAuthMethods?: string;
     CodeChallengeMethodsSupported?: string;
-    MetadataJSON?: string;
     CachedAt?: Date;
 }, {
     ID?: string;
     ExpiresAt?: Date;
     __mj_CreatedAt?: Date;
     __mj_UpdatedAt?: Date;
+    MetadataJSON?: string;
     IssuerURL?: string;
     AuthorizationEndpoint?: string;
     TokenEndpoint?: string;
@@ -14049,7 +14144,6 @@ export declare const MJOAuthAuthServerMetadataCacheSchema: z.ZodObject<{
     GrantTypesSupported?: string;
     TokenEndpointAuthMethods?: string;
     CodeChallengeMethodsSupported?: string;
-    MetadataJSON?: string;
     CachedAt?: Date;
 }>;
 export type MJOAuthAuthServerMetadataCacheEntityType = z.infer<typeof MJOAuthAuthServerMetadataCacheSchema>;
@@ -56813,19 +56907,19 @@ export declare class MJFormChromeRuleEntity extends BaseEntity<MJFormChromeRuleE
     Load(ID: string, EntityRelationshipsToLoad?: string[]): Promise<boolean>;
     /**
     * Validate() method override for MJ: Form Chrome Rules entity. This is an auto-generated method that invokes the generated validators for this entity for the following fields:
-    * * Table-Level: Ensures that if the Target Kind is 'Relationship', a Related Entity must be specified and the Contribution Key must be empty. Conversely, if the Target Kind is 'Contribution', a Contribution Key must be specified and the Related Entity must be empty.
+    * * Table-Level: Ensures that if the target kind is 'Relationship', a related entity is specified and the contribution key is empty. If the target kind is 'Contribution', a contribution key must be specified and the related entity must be empty.
     * @public
     * @method
     * @override
     */
     Validate(): ValidationResult;
     /**
-    * Ensures that if the Target Kind is 'Relationship', a Related Entity must be specified and the Contribution Key must be empty. Conversely, if the Target Kind is 'Contribution', a Contribution Key must be specified and the Related Entity must be empty.
+    * Ensures that if the target kind is 'Relationship', a related entity is specified and the contribution key is empty. If the target kind is 'Contribution', a contribution key must be specified and the related entity must be empty.
     * @param result - the ValidationResult object to add any errors or warnings to
     * @public
     * @method
     */
-    ValidateTargetKindDependencies(result: ValidationResult): void;
+    ValidateTargetKindAndAssociatedKeys(result: ValidationResult): void;
     /**
     * * Field Name: ID
     * * Display Name: ID
@@ -56874,7 +56968,7 @@ export declare class MJFormChromeRuleEntity extends BaseEntity<MJFormChromeRuleE
     set ContributionKey(value: string | null);
     /**
     * * Field Name: Inclusion
-    * * Display Name: Inclusion
+    * * Display Name: Inclusion Rule
     * * SQL Data Type: nvarchar(20)
     * * Value List Type: List
     * * Possible Values
@@ -56904,7 +56998,7 @@ export declare class MJFormChromeRuleEntity extends BaseEntity<MJFormChromeRuleE
     set Sequence(value: number);
     /**
     * * Field Name: Title
-    * * Display Name: Title
+    * * Display Name: Section Title
     * * SQL Data Type: nvarchar(100)
     * * Description: Optional admin display title for this section. Null keeps the relationship DisplayName or contribution name. Survives OpenApp upgrades because the row is keyed by RelatedEntityID / ContributionKey, not by the previous label.
     */
@@ -57215,6 +57309,267 @@ export declare class MJGeneratedCodeEntity extends BaseEntity<MJGeneratedCodeEnt
     */
     get LinkedEntity(): string | null;
 }
+/**
+ * MJ: Identity Claim Types - strongly typed entity sub-class
+ * * Schema: __mj
+ * * Base Table: IdentityClaimType
+ * * Base View: vwIdentityClaimTypes
+ * * @description Metadata catalog of identity claim types. Each row defines a claim kind whose lifecycle (create, claim, revoke, expire) is executed by a BaseIdentityClaimDriver plugin resolved at runtime from DriverClass via ClassFactory.
+ * * Primary Key: ID
+ * @extends {BaseEntity}
+ * @class
+ * @public
+ */
+export declare class MJIdentityClaimTypeEntity extends BaseEntity<MJIdentityClaimTypeEntityType> {
+    /**
+    * Loads the MJ: Identity Claim Types record from the database
+    * @param ID: string - primary key value to load the MJ: Identity Claim Types record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof MJIdentityClaimTypeEntity
+    * @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: Name
+    * * Display Name: Name
+    * * SQL Data Type: nvarchar(100)
+    * * Description: Unique name identifying this claim type (e.g., "EntitlementGrant", "PersonAccountLink", "OrgInvite").
+    */
+    get Name(): string;
+    set Name(value: string);
+    /**
+    * * Field Name: Description
+    * * Display Name: Description
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: Optional description explaining the intent and behavior of this claim type.
+    */
+    get Description(): string | null;
+    set Description(value: string | null);
+    /**
+    * * Field Name: DriverClass
+    * * Display Name: Driver Class
+    * * SQL Data Type: nvarchar(255)
+    * * Description: Plugin class name implementing BaseIdentityClaimDriver, registered via @RegisterClass(BaseIdentityClaimDriver, DriverClass) and resolved at runtime.
+    */
+    get DriverClass(): string;
+    set DriverClass(value: string);
+    /**
+    * * Field Name: Configuration
+    * * Display Name: Configuration
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: JSON configuration specific to this claim type driver.
+    */
+    get Configuration(): string | null;
+    set Configuration(value: string | null);
+    /**
+    * * Field Name: DefaultExpirationDays
+    * * Display Name: Default Expiration Days
+    * * SQL Data Type: int
+    * * Default Value: 30
+    * * Description: Default lifespan in days for claims of this type before they expire automatically.
+    */
+    get DefaultExpirationDays(): number;
+    set DefaultExpirationDays(value: number);
+    /**
+    * * Field Name: IsActive
+    * * Display Name: Is Active
+    * * SQL Data Type: bit
+    * * Default Value: 1
+    * * Description: Whether this claim type is active and available for issuing new claims.
+    */
+    get IsActive(): boolean;
+    set IsActive(value: boolean);
+    /**
+    * * 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;
+}
+/**
+ * MJ: Identity Claims - strongly typed entity sub-class
+ * * Schema: __mj
+ * * Base Table: IdentityClaim
+ * * Base View: vwIdentityClaims
+ * * @description Records of pending, claimed, or expired identity claims addressed to an email address. Facilitates cross-system entitlement claiming, account linking, and invite verification.
+ * * Primary Key: ID
+ * @extends {BaseEntity}
+ * @class
+ * @public
+ */
+export declare class MJIdentityClaimEntity extends BaseEntity<MJIdentityClaimEntityType> {
+    /**
+    * Loads the MJ: Identity Claims record from the database
+    * @param ID: string - primary key value to load the MJ: Identity Claims record.
+    * @param EntityRelationshipsToLoad - (optional) the relationships to load
+    * @returns {Promise<boolean>} - true if successful, false otherwise
+    * @public
+    * @async
+    * @memberof MJIdentityClaimEntity
+    * @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: ClaimTypeID
+    * * Display Name: Claim Type ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: MJ: Identity Claim Types (vwIdentityClaimTypes.ID)
+    * * Description: Foreign key linking this claim to its IdentityClaimType definition.
+    */
+    get ClaimTypeID(): string;
+    set ClaimTypeID(value: string);
+    /**
+    * * Field Name: NormalizedEmail
+    * * Display Name: Email Address
+    * * SQL Data Type: nvarchar(255)
+    * * Description: Normalized lowercase email address of the intended claimant.
+    */
+    get NormalizedEmail(): string;
+    set NormalizedEmail(value: string);
+    /**
+    * * Field Name: EntityID
+    * * Display Name: Entity ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: MJ: Entities (vwEntities.ID)
+    * * Description: Optional polymorphic foreign key to the Entity representing the resource being claimed.
+    */
+    get EntityID(): string | null;
+    set EntityID(value: string | null);
+    /**
+    * * Field Name: RecordID
+    * * Display Name: Record ID
+    * * SQL Data Type: nvarchar(255)
+    * * Description: Optional primary key / record ID of the specific entity record being claimed.
+    */
+    get RecordID(): string | null;
+    set RecordID(value: string | null);
+    /**
+    * * Field Name: PayloadJSON
+    * * Display Name: Payload
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: Optional payload JSON containing custom data or parameters consumed by the claim type driver during redemption.
+    */
+    get PayloadJSON(): string | null;
+    set PayloadJSON(value: string | null);
+    /**
+    * * Field Name: Status
+    * * Display Name: Status
+    * * SQL Data Type: nvarchar(20)
+    * * Default Value: Pending
+    * * Value List Type: List
+    * * Possible Values
+    *   * Claimed
+    *   * Expired
+    *   * Pending
+    *   * Revoked
+    * * Description: Current lifecycle state of the claim: Pending, Claimed, Expired, or Revoked.
+    */
+    get Status(): 'Claimed' | 'Expired' | 'Pending' | 'Revoked';
+    set Status(value: 'Claimed' | 'Expired' | 'Pending' | 'Revoked');
+    /**
+    * * Field Name: ExpiresAt
+    * * Display Name: Expires At
+    * * SQL Data Type: datetimeoffset
+    * * Description: Timestamp after which this claim can no longer be redeemed.
+    */
+    get ExpiresAt(): Date;
+    set ExpiresAt(value: Date);
+    /**
+    * * Field Name: ClaimedAt
+    * * Display Name: Claimed At
+    * * SQL Data Type: datetimeoffset
+    * * Description: Timestamp when the claim was successfully redeemed.
+    */
+    get ClaimedAt(): Date | null;
+    set ClaimedAt(value: Date | null);
+    /**
+    * * Field Name: ClaimedByUserID
+    * * Display Name: Claimed By User ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: MJ: Users (vwUsers.ID)
+    * * Description: User ID of the authenticated user who successfully claimed this record.
+    */
+    get ClaimedByUserID(): string | null;
+    set ClaimedByUserID(value: string | null);
+    /**
+    * * Field Name: MagicLinkInviteID
+    * * Display Name: Magic Link Invite ID
+    * * SQL Data Type: uniqueidentifier
+    * * Related Entity/Foreign Key: MJ: Magic Link Invites (vwMagicLinkInvites.ID)
+    * * Description: Optional link to a MagicLinkInvite record for email ownership verification links.
+    */
+    get MagicLinkInviteID(): string | null;
+    set MagicLinkInviteID(value: string | null);
+    /**
+    * * Field Name: MetadataJSON
+    * * Display Name: Metadata
+    * * SQL Data Type: nvarchar(MAX)
+    * * Description: Optional metadata JSON for auditing or tracking client provenance.
+    */
+    get MetadataJSON(): string | null;
+    set MetadataJSON(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: ClaimType
+    * * Display Name: Claim Type
+    * * SQL Data Type: nvarchar(100)
+    */
+    get ClaimType(): string;
+    /**
+    * * Field Name: Entity
+    * * Display Name: Entity
+    * * SQL Data Type: nvarchar(255)
+    */
+    get Entity(): string | null;
+    /**
+    * * Field Name: ClaimedByUser
+    * * Display Name: Claimed By User
+    * * SQL Data Type: nvarchar(100)
+    */
+    get ClaimedByUser(): string | null;
+}
 /**
  * MJ: Instance Configurations - strongly typed entity sub-class
  * * Schema: __mj