@memberjunction/core 2.72.0 → 2.74.0

package/dist/generic/queryInfo.d.ts

@@ -1,43 +1,178 @@
 import { BaseInfo } from "./baseInfo";
 import { EntityInfo } from "./entityInfo";
+import { UserInfo } from "./securityInfo";
 /**
- * Metadata about a single stored query in the database.
+ * Catalog of stored queries. This is useful for any arbitrary query that is known to be performant and correct and can be reused.
+ * Queries can be viewed/run by a user, used programatically via RunQuery, and also used by AI systems for improved reliability
+ * instead of dynamically generated SQL. Queries can also improve security since they store the SQL instead of using dynamic SQL.
  */
 export declare class QueryInfo extends BaseInfo {
+    /**
+     * Unique identifier for the query record
+     */
     ID: string;
+    /**
+     * Name of the query for display and reference
+     */
     Name: string;
+    /**
+     * Detailed description of what the query does and what data it returns
+     */
     Description: string;
+    /**
+     * Foreign key reference to the Query Categories entity
+     */
     CategoryID: string;
+    /**
+     * The actual SQL query text to execute, may include Nunjucks template parameters
+     */
     SQL: string;
+    /**
+     * The original SQL before any optimization or modification, kept for reference and comparison
+     */
     OriginalSQL: string;
+    /**
+     * User feedback on query accuracy, performance, or suggested improvements
+     */
     Feedback: string;
+    /**
+     * Current status of the query in the approval workflow
+     */
     Status: 'Pending' | 'In-Review' | 'Approved' | 'Rejected' | 'Obsolete';
+    /**
+     * Value indicating the quality of the query, higher values mean better quality
+     */
     QualityRank: number;
+    /**
+     * Automatically set to true when the SQL column contains Nunjucks template markers like {{paramName}}
+     */
+    UsesTemplate: boolean;
+    /**
+     * Date and time when this query record was created
+     */
     __mj_CreatedAt: Date;
+    /**
+     * Date and time when this query record was last updated
+     */
     __mj_UpdatedAt: Date;
+    /**
+     * Category name from the related Query Categories entity
+     */
     Category: string;
     private _fields;
+    /**
+     * Gets the field metadata for this query, including display names, data types, and formatting rules.
+     * @returns {QueryFieldInfo[]} Array of field metadata for the query
+     */
     get Fields(): QueryFieldInfo[];
+    /**
+     * Gets the permissions that control access to this query, defining which users and roles can run it.
+     * @returns {QueryPermissionInfo[]} Array of permission settings for the query
+     */
     get Permissions(): QueryPermissionInfo[];
+    private _parameters;
+    /**
+     * Gets the parameter definitions for this parameterized query if it uses Nunjucks templates.
+     * Parameters include validation filters and metadata for type-safe query execution.
+     * @returns {QueryParameterInfo[]} Array of parameter definitions for the query
+     */
+    get Parameters(): QueryParameterInfo[];
+    private _entities;
+    /**
+     * Gets the entities that are involved in this query, tracking which MemberJunction entities are referenced.
+     * @returns {QueryEntityInfo[]} Array of entities used by the query
+     */
+    get Entities(): QueryEntityInfo[];
     constructor(initData?: any);
+    /**
+     * Gets the category information for this query, supporting hierarchical organization.
+     * @returns {QueryCategoryInfo} The category this query belongs to, or undefined if not categorized
+     */
     get CategoryInfo(): QueryCategoryInfo;
+    /**
+     * Checks if a user has permission to run this query based on their roles.
+     * A user can run a query if:
+     * 1. The query has no permissions defined (open to all)
+     * 2. The user has at least one role that is granted permission
+     *
+     * @param user The user to check permissions for
+     * @returns true if the user has permission to run the query
+     */
+    UserHasRunPermissions(user: UserInfo): boolean;
+    /**
+     * Checks if a user can run this query, considering both permissions and query status.
+     * A query can be run if:
+     * 1. The user has permission to run it (via UserHasRunPermissions)
+     * 2. The query status is 'Approved'
+     *
+     * @param user The user to check
+     * @returns true if the user can run the query right now
+     */
+    UserCanRun(user: UserInfo): boolean;
 }
+/**
+ * Organizes saved queries into categories for discovery and management, supporting folder-like organization of queries.
+ */
 export declare class QueryCategoryInfo extends BaseInfo {
+    /**
+     * Unique identifier for the query category
+     */
     ID: string;
+    /**
+     * Name of the category for organizing queries
+     */
     Name: string;
+    /**
+     * Foreign key to parent category for hierarchical organization
+     */
     ParentID: string;
+    /**
+     * Description of what types of queries belong in this category
+     */
     Description: string;
+    /**
+     * Date and time when this category was created
+     */
     __mj_CreatedAt: Date;
+    /**
+     * Date and time when this category was last updated
+     */
     __mj_UpdatedAt: Date;
+    /**
+     * Parent category name from the related category
+     */
     Parent: string;
     constructor(initData?: any);
+    /**
+     * Gets the parent category information for hierarchical category organization.
+     * @returns {QueryCategoryInfo} The parent category, or undefined if this is a top-level category
+     */
     get ParentCategoryInfo(): QueryCategoryInfo;
+    /**
+     * Gets all queries that belong to this category.
+     * @returns {QueryInfo[]} Array of queries in this category
+     */
     get Queries(): QueryInfo[];
 }
+/**
+ * Stores field-level metadata for queries including display names, data types, and formatting rules for result presentation.
+ */
 export declare class QueryFieldInfo extends BaseInfo {
+    /**
+     * Name of the field as it appears in query results
+     */
     Name: string;
+    /**
+     * Foreign key to the parent query
+     */
     QueryID: string;
+    /**
+     * Description of what this field represents
+     */
     Description: string;
+    /**
+     * Display order of this field in query results
+     */
     Sequence: number;
     /**
      * The base type, not including parameters, in SQL. For example this field would be nvarchar or decimal, and wouldn't include type parameters. The SQLFullType field provides that information.
@@ -47,24 +182,200 @@ export declare class QueryFieldInfo extends BaseInfo {
      * The full SQL type for the field, for example datetime or nvarchar(10) etc.
      */
     SQLFullType: string;
+    /**
+     * Foreign key to the source entity this field comes from
+     */
     SourceEntityID: string;
+    /**
+     * Name of the field in the source entity
+     */
     SourceFieldName: string;
+    /**
+     * Whether this field is computed rather than directly selected from a table
+     */
     IsComputed: boolean;
+    /**
+     * Explanation of how this computed field is calculated
+     */
     ComputationDescription: string;
+    /**
+     * Whether this field represents a summary/aggregate value
+     */
     IsSummary: boolean;
+    /**
+     * Description of the summary calculation
+     */
     SummaryDescription: string;
+    /**
+     * Date and time when this field was created
+     */
     __mj_CreatedAt: Date;
+    /**
+     * Date and time when this field was last updated
+     */
     __mj_UpdatedAt: Date;
+    /**
+     * Source entity name if field is from an entity
+     */
     SourceEntity: string;
     constructor(initData?: any);
+    /**
+     * Gets the entity information for the source entity this field comes from.
+     * @returns {EntityInfo} The source entity metadata, or undefined if not linked to an entity
+     */
     get SourceEntityInfo(): EntityInfo;
+    /**
+     * Gets the query information this field belongs to.
+     * @returns {QueryInfo} The parent query metadata
+     */
     get QueryInfo(): QueryInfo;
 }
+/**
+ * Controls access to queries by defining which users and roles can run specific queries.
+ */
 export declare class QueryPermissionInfo extends BaseInfo {
+    /**
+     * Foreign key to the query this permission applies to
+     */
     QueryID: string;
+    /**
+     * Name of the role that has permission to run this query
+     */
     RoleName: string;
+    /**
+     * Query name from the related query
+     */
+    Query: string;
+    constructor(initData?: any);
+    /**
+     * Gets the query information this permission applies to.
+     * @returns {QueryInfo} The query metadata this permission controls
+     */
+    get QueryInfo(): QueryInfo;
+}
+/**
+ * Tracks which entities are involved in a given query. The Queries table stores SQL and descriptions for stored queries
+ * that can be executed and serve as examples for AI.
+ */
+export declare class QueryEntityInfo extends BaseInfo {
+    /**
+     * References the ID of the query in the Queries table
+     */
+    QueryID: string;
+    /**
+     * References the ID of the entity in the Entities table
+     */
+    EntityID: string;
+    /**
+     * Order sequence for multiple entities in a query
+     */
+    Sequence: number;
+    /**
+     * How this entity association was detected: AI (automatic) or Manual (user-specified)
+     */
+    DetectionMethod: 'AI' | 'Manual';
+    /**
+     * Confidence score (0.00-1.00) when AI detection was used
+     */
+    AutoDetectConfidenceScore: number;
+    /**
+     * Date and time when this association was created
+     */
+    __mj_CreatedAt: Date;
+    /**
+     * Date and time when this association was last updated
+     */
+    __mj_UpdatedAt: Date;
+    /**
+     * Query name from the related query
+     */
     Query: string;
+    /**
+     * Entity name from the related entity
+     */
+    Entity: string;
     constructor(initData?: any);
+    /**
+     * Gets the query information this entity relationship belongs to.
+     * @returns {QueryInfo} The parent query metadata
+     */
     get QueryInfo(): QueryInfo;
+    /**
+     * Gets the entity information for the entity involved in this query.
+     * @returns {EntityInfo} The entity metadata
+     */
+    get EntityInfo(): EntityInfo;
+}
+/**
+ * Stores parameter definitions for parameterized queries that use Nunjucks templates. Each parameter represents a dynamic value
+ * that can be passed when executing the query. Parameters are automatically extracted from the query template by the QueryEntityServer
+ * using LLM analysis, or can be manually defined. The combination of parameter metadata and validation filters creates a
+ * self-documenting, type-safe query execution system.
+ */
+export declare class QueryParameterInfo extends BaseInfo {
+    /**
+     * Foreign key to the query this parameter belongs to
+     */
+    QueryID: string;
+    /**
+     * The name of the parameter as it appears in the Nunjucks template (e.g., {{parameterName}})
+     */
+    Name: string;
+    /**
+     * Data type of the parameter for validation and type casting
+     */
+    Type: 'string' | 'number' | 'date' | 'boolean' | 'array';
+    /**
+     * Whether this parameter must be provided when executing the query
+     */
+    IsRequired: boolean;
+    /**
+     * Default value to use when parameter is not provided
+     */
+    DefaultValue: string;
+    /**
+     * Human-readable description of what this parameter is for
+     */
+    Description: string;
+    /**
+     * Example value demonstrating the proper format for this parameter
+     */
+    SampleValue: string;
+    /**
+     * JSON array of Nunjucks filter definitions for value transformation
+     */
+    ValidationFilters: string;
+    /**
+     * How this parameter was detected: AI (automatic) or Manual (user-specified)
+     */
+    DetectionMethod: 'AI' | 'Manual';
+    /**
+     * Confidence score (0.00-1.00) when AI detection was used
+     */
+    AutoDetectConfidenceScore: number;
+    /**
+     * Date and time when this parameter was created
+     */
+    __mj_CreatedAt: Date;
+    /**
+     * Date and time when this parameter was last updated
+     */
+    __mj_UpdatedAt: Date;
+    /**
+     * Query name from the related query
+     */
+    Query: string;
+    constructor(initData?: any);
+    /**
+     * Gets the query information this parameter belongs to.
+     * @returns {QueryInfo} The parent query metadata
+     */
+    get QueryInfo(): QueryInfo;
+    /**
+     * Gets the parsed validation filters for this parameter.
+     * Parses the JSON string of filter definitions into an array of filter objects.
+     * @returns {any[]} Array of parsed filter definitions, or empty array if parsing fails
+     */
+    get ParsedFilters(): any[];
 }
 //# sourceMappingURL=queryInfo.d.ts.map

package/dist/generic/queryInfo.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"queryInfo.d.ts","sourceRoot":"","sources":["../../src/generic/queryInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAG1C;;GAEG;AACH,qBAAa,SAAU,SAAQ,QAAQ;IAC5B,EAAE,EAAE,MAAM,CAAO;IACjB,IAAI,EAAE,MAAM,CAAO;IACnB,WAAW,EAAE,MAAM,CAAQ;IAC3B,UAAU,EAAE,MAAM,CAAO;IACzB,GAAG,EAAE,MAAM,CAAO;IAClB,WAAW,EAAE,MAAM,CAAO;IAC1B,QAAQ,EAAE,MAAM,CAAO;IACvB,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,UAAU,CAAO;IAC7E,WAAW,EAAE,MAAM,CAAO;IACjC,cAAc,EAAE,IAAI,CAAO;IAC3B,cAAc,EAAE,IAAI,CAAO;IAG3B,QAAQ,EAAE,MAAM,CAAO;IAEvB,OAAO,CAAC,OAAO,CAAyB;IACxC,IAAW,MAAM,IAAI,cAAc,EAAE,CAKpC;IAED,IAAW,WAAW,IAAI,mBAAmB,EAAE,CAE9C;gBAEW,QAAQ,GAAE,GAAU;IAiBhC,IAAI,YAAY,IAAI,iBAAiB,CAEpC;CACJ;AAED,qBAAa,iBAAkB,SAAQ,QAAQ;IACpC,EAAE,EAAE,MAAM,CAAO;IACjB,IAAI,EAAE,MAAM,CAAO;IACnB,QAAQ,EAAE,MAAM,CAAO;IACvB,WAAW,EAAE,MAAM,CAAO;IACjC,cAAc,EAAE,IAAI,CAAO;IAC3B,cAAc,EAAE,IAAI,CAAO;IAG3B,MAAM,EAAE,MAAM,CAAO;gBAET,QAAQ,GAAE,GAAU;IAOhC,IAAI,kBAAkB,IAAI,iBAAiB,CAE1C;IAED,IAAI,OAAO,IAAI,SAAS,EAAE,CAEzB;CACJ;AAED,qBAAa,cAAe,SAAQ,QAAQ;IACxC,IAAI,EAAE,MAAM,CAAO;IACnB,OAAO,EAAE,MAAM,CAAO;IACtB,WAAW,EAAE,MAAM,CAAO;IAC1B,QAAQ,EAAE,MAAM,CAAO;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAO;IAC1B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAO;IAC1B,cAAc,EAAE,MAAM,CAAO;IAC7B,eAAe,EAAE,MAAM,CAAO;IAC9B,UAAU,EAAE,OAAO,CAAO;IAC1B,sBAAsB,EAAE,MAAM,CAAO;IACrC,SAAS,EAAE,OAAO,CAAO;IACzB,kBAAkB,EAAE,MAAM,CAAO;IACjC,cAAc,EAAE,IAAI,CAAO;IAC3B,cAAc,EAAE,IAAI,CAAO;IAG3B,YAAY,EAAE,MAAM,CAAO;gBAEf,QAAQ,GAAE,GAAU;IAOhC,IAAI,gBAAgB,IAAI,UAAU,CAEjC;IAED,IAAI,SAAS,IAAI,SAAS,CAEzB;CACJ;AAGD,qBAAa,mBAAoB,SAAQ,QAAQ;IACtC,OAAO,EAAE,MAAM,CAAO;IACtB,QAAQ,EAAE,MAAM,CAAO;IAG9B,KAAK,EAAE,MAAM,CAAO;gBAER,QAAQ,GAAE,GAAU;IAOhC,IAAI,SAAS,IAAI,SAAS,CAEzB;CACJ"}
+{"version":3,"file":"queryInfo.d.ts","sourceRoot":"","sources":["../../src/generic/queryInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C;;;;GAIG;AACH,qBAAa,SAAU,SAAQ,QAAQ;IACnC;;OAEG;IACI,EAAE,EAAE,MAAM,CAAO;IACxB;;OAEG;IACI,IAAI,EAAE,MAAM,CAAO;IAC1B;;OAEG;IACI,WAAW,EAAE,MAAM,CAAQ;IAClC;;OAEG;IACI,UAAU,EAAE,MAAM,CAAO;IAChC;;OAEG;IACI,GAAG,EAAE,MAAM,CAAO;IACzB;;OAEG;IACI,WAAW,EAAE,MAAM,CAAO;IACjC;;OAEG;IACI,QAAQ,EAAE,MAAM,CAAO;IAC9B;;OAEG;IACI,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,UAAU,CAAO;IACpF;;OAEG;IACI,WAAW,EAAE,MAAM,CAAO;IACjC;;OAEG;IACI,YAAY,EAAE,OAAO,CAAQ;IACpC;;OAEG;IACH,cAAc,EAAE,IAAI,CAAO;IAC3B;;OAEG;IACH,cAAc,EAAE,IAAI,CAAO;IAG3B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAO;IAEvB,OAAO,CAAC,OAAO,CAAyB;IACxC;;;OAGG;IACH,IAAW,MAAM,IAAI,cAAc,EAAE,CAKpC;IAED;;;OAGG;IACH,IAAW,WAAW,IAAI,mBAAmB,EAAE,CAE9C;IAED,OAAO,CAAC,WAAW,CAA8B;IACjD;;;;OAIG;IACH,IAAW,UAAU,IAAI,kBAAkB,EAAE,CAK5C;IAED,OAAO,CAAC,SAAS,CAA2B;IAC5C;;;OAGG;IACH,IAAW,QAAQ,IAAI,eAAe,EAAE,CAKvC;gBAEW,QAAQ,GAAE,GAAU;IAiBhC;;;OAGG;IACH,IAAI,YAAY,IAAI,iBAAiB,CAEpC;IAED;;;;;;;;OAQG;IACI,qBAAqB,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO;IAoBrD;;;;;;;;OAQG;IACI,UAAU,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO;CAS7C;AAED;;GAEG;AACH,qBAAa,iBAAkB,SAAQ,QAAQ;IAC3C;;OAEG;IACI,EAAE,EAAE,MAAM,CAAO;IACxB;;OAEG;IACI,IAAI,EAAE,MAAM,CAAO;IAC1B;;OAEG;IACI,QAAQ,EAAE,MAAM,CAAO;IAC9B;;OAEG;IACI,WAAW,EAAE,MAAM,CAAO;IACjC;;OAEG;IACH,cAAc,EAAE,IAAI,CAAO;IAC3B;;OAEG;IACH,cAAc,EAAE,IAAI,CAAO;IAG3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAO;gBAET,QAAQ,GAAE,GAAU;IAOhC;;;OAGG;IACH,IAAI,kBAAkB,IAAI,iBAAiB,CAE1C;IAED;;;OAGG;IACH,IAAI,OAAO,IAAI,SAAS,EAAE,CAEzB;CACJ;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,QAAQ;IACxC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAO;IACnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAO;IACtB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAO;IAC1B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAO;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAO;IAC1B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAO;IAC1B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAO;IAC7B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAO;IAC9B;;OAEG;IACH,UAAU,EAAE,OAAO,CAAO;IAC1B;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAO;IACrC;;OAEG;IACH,SAAS,EAAE,OAAO,CAAO;IACzB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAO;IACjC;;OAEG;IACH,cAAc,EAAE,IAAI,CAAO;IAC3B;;OAEG;IACH,cAAc,EAAE,IAAI,CAAO;IAG3B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAO;gBAEf,QAAQ,GAAE,GAAU;IAOhC;;;OAGG;IACH,IAAI,gBAAgB,IAAI,UAAU,CAEjC;IAED;;;OAGG;IACH,IAAI,SAAS,IAAI,SAAS,CAEzB;CACJ;AAGD;;GAEG;AACH,qBAAa,mBAAoB,SAAQ,QAAQ;IAC7C;;OAEG;IACI,OAAO,EAAE,MAAM,CAAO;IAC7B;;OAEG;IACI,QAAQ,EAAE,MAAM,CAAO;IAG9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAO;gBAER,QAAQ,GAAE,GAAU;IAOhC;;;OAGG;IACH,IAAI,SAAS,IAAI,SAAS,CAEzB;CACJ;AAED;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,QAAQ;IACzC;;OAEG;IACI,OAAO,EAAE,MAAM,CAAO;IAC7B;;OAEG;IACI,QAAQ,EAAE,MAAM,CAAO;IAC9B;;OAEG;IACI,QAAQ,EAAE,MAAM,CAAO;IAC9B;;OAEG;IACI,eAAe,EAAE,IAAI,GAAG,QAAQ,CAAW;IAClD;;OAEG;IACI,yBAAyB,EAAE,MAAM,CAAO;IAC/C;;OAEG;IACH,cAAc,EAAE,IAAI,CAAO;IAC3B;;OAEG;IACH,cAAc,EAAE,IAAI,CAAO;IAG3B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAO;IACpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAO;gBAET,QAAQ,GAAE,GAAU;IAOhC;;;OAGG;IACH,IAAI,SAAS,IAAI,SAAS,CAEzB;IAED;;;OAGG;IACH,IAAI,UAAU,IAAI,UAAU,CAE3B;CACJ;AAED;;;;;GAKG;AACH,qBAAa,kBAAmB,SAAQ,QAAQ;IAC5C;;OAEG;IACI,OAAO,EAAE,MAAM,CAAO;IAC7B;;OAEG;IACI,IAAI,EAAE,MAAM,CAAO;IAC1B;;OAEG;IACI,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,SAAS,GAAG,OAAO,CAAO;IACtE;;OAEG;IACI,UAAU,EAAE,OAAO,CAAQ;IAClC;;OAEG;IACI,YAAY,EAAE,MAAM,CAAO;IAClC;;OAEG;IACI,WAAW,EAAE,MAAM,CAAO;IACjC;;OAEG;IACI,WAAW,EAAE,MAAM,CAAO;IACjC;;OAEG;IACI,iBAAiB,EAAE,MAAM,CAAO;IACvC;;OAEG;IACI,eAAe,EAAE,IAAI,GAAG,QAAQ,CAAW;IAClD;;OAEG;IACI,yBAAyB,EAAE,MAAM,CAAO;IAC/C;;OAEG;IACH,cAAc,EAAE,IAAI,CAAO;IAC3B;;OAEG;IACH,cAAc,EAAE,IAAI,CAAO;IAG3B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAO;gBAER,QAAQ,GAAE,GAAU;IAOhC;;;OAGG;IACH,IAAI,SAAS,IAAI,SAAS,CAEzB;IAED;;;;OAIG;IACH,IAAI,aAAa,IAAI,GAAG,EAAE,CAMzB;CACJ"}