@memberjunction/server 2.45.0 → 2.47.0

package/src/entitySubclasses/reportEntity.server.ts

@@ -1,130 +0,0 @@
-import { BaseEntity, Metadata, RunView } from "@memberjunction/core";
-import { RegisterClass, SafeJSONParse } from "@memberjunction/global";
-import { ReportEntity, ReportSnapshotEntity, ReportVersionEntity } from "@memberjunction/core-entities";
-import { SkipAPIAnalysisCompleteResponse } from "@memberjunction/skip-types";
-
-@RegisterClass(BaseEntity, 'Reports')
-export class ReportEntity_Server extends ReportEntity  {
-    /**
-     * The server side Report Entity sub-class has a simple logic that will create a snapshot of the report when it is first created and each time it is modified, but only
-     * if it is either newly created or if the Configuration field has changed.
-     * @returns 
-     */
-    public async Save(): Promise<boolean> {
-        try {
-            // first let's get the actual parsed object for the Configuration field
-            const config = this.Configuration && this.Configuration.length > 0 ? SafeJSONParse(this.Configuration) : null;
-            const oldTextConfig = this.GetFieldByName('Configuration')?.OldValue;
-            const oldConfig = oldTextConfig && oldTextConfig.length > 0 ? SafeJSONParse(oldTextConfig) : null;
- 
-            if ( (config && oldConfig) || (config && !this.IsSaved) ) {
-                let createSnapshot = false;
-                let createReportVersion = false;
-                if (this.IsSaved) {
-                    // existing record
-                    // we nave a configuration and an old configuration, so we can compare them, cast them to their strong types first
-                    const castedConfig = config as SkipAPIAnalysisCompleteResponse;
-                    const castedOldConfig = oldConfig as SkipAPIAnalysisCompleteResponse;
-
-                    // Next, we need to see if the data context has changed at all. We do this by comparing the # of items in the data context. a Data context's items are immutable and we only add new Data Context Items
-                    // so we can simply check to see if we have new data context items or not
-                    const dataContextChanged = Object.keys(castedConfig.dataContext || {})?.length !== Object.keys(castedOldConfig.dataContext || {})?.length;
-
-                    // next up, we check to see if anything in the execution results changed. The simple way to do that is convert the execution results back to a string and compare those strings
-                    const executionResultsChanged = JSON.stringify(castedConfig.executionResults) !== JSON.stringify(castedOldConfig.executionResults);
-
-                    // next up we check to see if the analysis changed, which would also represent a "data" change
-                    const analysisChanged = castedConfig.analysis !== castedOldConfig.analysis;
-
-                    // finally, we check to see if the configuration itself has OUTSIDE of the data elements we just checked. We do that by deleting those properties from those objects, converting to strings
-                    // and comparing them
-                    delete castedConfig.dataContext;
-                    delete castedConfig.analysis;
-                    delete castedConfig.executionResults;
-
-                    delete castedOldConfig.dataContext;
-                    delete castedOldConfig.executionResults;
-                    delete castedOldConfig.analysis;
-
-                    // we can now compare the two objects
-                    const configChanged = JSON.stringify(castedConfig) !== JSON.stringify(castedOldConfig);
-
-                    // now our logic is this - if the DATA changed, but the configuration did NOT change, that means we want to create a new SNAPSHOT of the report - which is the data changing side
-                    // if the configuration changed at all we wnat to create a new Report Version. Sometimes both changd and we do both
-                    createSnapshot = dataContextChanged || executionResultsChanged || analysisChanged;
-                    createReportVersion = configChanged;
-                }
-                else {
-                    // we have a new record set createSnapshot to true and createReportVersion to true
-                    createSnapshot = true;
-                    createReportVersion = true;
-                }
-
-                const wasNewRecord: boolean = !this.IsSaved;
-                const saveResult: boolean = await super.Save();
-                if (saveResult && (createSnapshot || createReportVersion)) {
-                    // here we either have a new record or the configuration has changed, so we need to create a snapshot of the report
-                    let success: boolean = true;
-                    const md = new Metadata();
-
-                    if (createReportVersion) {
-                        const reportVersion = await md.GetEntityObject<ReportVersionEntity>('MJ: Report Versions', this.ContextCurrentUser);
-                        reportVersion.ReportID = this.ID;
-                        // const get highest new version number already in DB
-                        let newVersionNumber: number = 1;
-                        if (!wasNewRecord) {
-                            const rv = new RunView();
-                            const rvResult = await rv.RunView({
-                                Fields: ['VersionNumber'],
-                                EntityName: 'MJ: Report Versions',
-                                ExtraFilter: `ReportID = '${this.ID}'`,
-                                MaxRows: 1,
-                                OrderBy: 'VersionNumber DESC',
-                            }, this.ContextCurrentUser);
-                            if (rvResult.Success && rvResult.Results.length > 0) {
-                                newVersionNumber = parseInt(rvResult.Results[0].VersionNumber) + 1;
-                            }
-                            else {
-                                newVersionNumber = 1; // this is an error state as we previously had a saved report, BUT there were no saved versions for the report, so we are going to use 1 here, but let's log a warning
-                                console.warn('ReportEntity_Server.Save(): No report versions found for report ID:', this.ID);
-                                console.warn('ReportEntity_Server.Save(): Using version number 1 for new report version');
-                            }
-                        }
-                        reportVersion.Name = this.Name; // copy current name to the new version
-                        reportVersion.Description = this.Description; // copy current description to the new version
-                        reportVersion.VersionNumber = newVersionNumber;
-                        reportVersion.Configuration = JSON.stringify(this.Configuration);
-                        success = success && await reportVersion.Save();
-                        if (!success) {
-                            console.error('ReportEntity_Server.Save(): Error saving report version\n' + reportVersion.LatestResult.Message);
-                        }
-                    }
-
-                    if (createSnapshot) {
-                        const snapshot = await md.GetEntityObject<ReportSnapshotEntity>('Report Snapshots', this.ContextCurrentUser);
-                        snapshot.ReportID = this.ID;
-                        snapshot.UserID = this.ContextCurrentUser.ID;
-                        // in the snapshot entity the ResultSet column is the Configuration column from the Report entity
-                        snapshot.ResultSet = JSON.stringify(this.Configuration);
-                        success = success && await snapshot.Save();
-                    }
-
-                    return success;
-                }        
-                else {
-                    return saveResult;    
-                }    
-            }
-            else {
-                // no configuration or no parseable configuration, so we just call super.Save();
-                return super.Save();
-            }
-        }
-        catch (e) {
-            console.error('Error in ReportEntity_Server.Save():', e);
-            return false;
-        }
-    }
-}
-
-export function LoadReportEntityServerSubClass() {}

package/src/entitySubclasses/userViewEntity.server.ts

@@ -1,231 +0,0 @@
-import { CleanJSON, MJGlobal, RegisterClass } from "@memberjunction/global";
-import { BaseEntity, EntityInfo, LogError, Metadata } from "@memberjunction/core";
-import { AIModelEntity, AIModelEntityExtended, UserViewEntityExtended } from '@memberjunction/core-entities'
-import { BaseLLM, ChatParams, GetAIAPIKey } from "@memberjunction/ai";
-import { AIEngine } from "@memberjunction/aiengine";
-import { LoadOpenAILLM } from "@memberjunction/ai-openai";
-LoadOpenAILLM(); // this is to prevent tree shaking since the openai package is not directly used and rather instantiated dynamically in the LoadOpenAILLM function. Since no static code path exists tree shaking can result in this class being optimized out
-
-@RegisterClass(BaseEntity, 'User Views')  
-export class UserViewEntity_Server extends UserViewEntityExtended  {
-    /**
-     * This property is hard-coded to true in this class because we DO support smart filters in this class. If you want to disable smart filters for a specific view you can override this property in your subclass and set it to false.
-     */
-    protected override get SmartFilterImplemented(): boolean {
-        return true;
-    }
-
-    /**
-     * Default implementation simply returns 'OpenAI' - override this in your subclass if you are using a different AI vendor.
-     * @returns 
-     */
-    protected get AIVendorName(): string {
-        return 'OpenAI';
-    }
-
-    /**
-     * Default implementation simply grabs the first AI model that matches GetAIModelName().
-     * @returns 
-     */
-    protected async GetAIModel(): Promise<AIModelEntityExtended> {
-        await AIEngine.Instance.Config(false, this.ContextCurrentUser); // most of the time this is already loaded, but just in case it isn't we will load it here
-        const models = AIEngine.Instance.Models.filter(m => m.AIModelType.trim().toLowerCase() === 'llm' && 
-                                                   m.Vendor.trim().toLowerCase() === this.AIVendorName.trim().toLowerCase())  
-        // next, sort the models by the PowerRank field so that the highest power rank model is the first array element
-        models.sort((a, b) => b.PowerRank - a.PowerRank); // highest power rank first
-        return models[0];
-    }
-
-    /** 
-     * This method will use AI to return a valid WHERE clause based on the provided prompt. This is automatically called at the right time if the view has SmartFilterEnabled turned on and the SmartFilterPrompt is set. If you want
-     * to call this directly to get back a WHERE clause for other purposes you can call this method directly and provide both a prompt and the entity that the view is based on.
-     * @param prompt 
-     */
-    public async GenerateSmartFilterWhereClause(prompt: string, entityInfo: EntityInfo): Promise<{whereClause: string, userExplanation: string}> {
-        try {
-            const model = await this.GetAIModel();
-            const llm = MJGlobal.Instance.ClassFactory.CreateInstance<BaseLLM>(BaseLLM, model.DriverClass, GetAIAPIKey(model.DriverClass)); 
-
-            const chatParams: ChatParams = {
-                model: model.APINameOrName,
-                messages: [      
-                    {
-                        role: 'system',
-                        content: this.GenerateSysPrompt(entityInfo)
-                    },
-                    {
-                        role: 'user',
-                        content: `${prompt}`,
-                    },
-                ],
-            }
-            const result = await llm.ChatCompletion(chatParams);
-            if (result && result.data) {
-                const llmResponse = result.data.choices[0].message.content;
-                if (llmResponse) {
-                    // try to parse it as JSON
-                    try {
-                        const cleansed = CleanJSON(llmResponse);
-                        if (!cleansed)
-                            throw new Error('Invalid JSON response from AI: ' + llmResponse);
-
-                        const parsed = JSON.parse(cleansed);
-                        if (parsed.whereClause && parsed.whereClause.length > 0) {
-                            // we have the where clause. Sometimes the LLM prefixes it with WHERE and somtimes not, we need to strip WHERE if it is there
-                            const trimmed = parsed.whereClause.trim();
-                            let ret: string = '';
-                            if (trimmed.toLowerCase().startsWith('where '))
-                                ret = trimmed.substring(6);
-                            else
-                                ret = parsed.whereClause;
-
-                            return  { 
-                                        whereClause: ret, 
-                                        userExplanation: parsed.userExplanationMessage
-                                    };
-                        }
-                        else if (parsed.whereClause !== undefined && parsed.whereClause !== null) {
-                            return  { 
-                                whereClause: '',  // empty string is valid, it means no where clause
-                                userExplanation: parsed.userExplanationMessage
-                            };
-                        }
-                        else {
-                            // if we get here, no whereClause property was provided by the LLM, that is an error
-                            throw new Error('Invalid response from AI, no whereClause property found in response: ' + llmResponse);
-                        }
-                    }
-                    catch (e) {
-                        LogError(e);
-                        throw new Error('Error parsing JSON response from AI: ' + llmResponse);
-                    }
-                }
-                else 
-                    throw new Error('Null response from AI');
-            }
-            else
-                throw new Error('No result returned from AI');
-        }
-        catch (e) {
-            LogError(e);
-            throw e;
-        }
-    }
-
-    public GenerateSysPrompt(entityInfo: EntityInfo): string {
-        const processedViews: string[] = [entityInfo.BaseView];
-        const md = new Metadata();
-        const listsEntity = md.EntityByName("Lists");
-        const listDetailsEntity = md.EntityByName("List Details");
-        const gptSysPrompt: string = `You are an expert in SQL and Microsoft SQL Server.
-You will be provided a user prompt representing how they want to filter the data.
-You may *NOT* use JOINS, only sub-queries for related tables. 
-
-I am a bot and can only understand JSON. Your response must be parsable into this type:
-const returnType = {
-    whereClause: string,
-    orderByClause: string
-    userExplanationMessage: string
-};
-
-In MemberJunction, we have a concept called "Entities" and these are metadata constructs that wrap SQL tables and views. The entity that we are currently 
-building a filter for is called "${entityInfo.Name}" and has an ID of "${entityInfo.ID}" 
-
-You won't be using this Entity name or ID in your SQL, unless you need to use it for List filtering (more on that below).
-
-The view that the user is querying is called ${entityInfo.BaseView} and has these fields:
-${entityInfo.Fields.map(f => {
-    let ret: string = `${f.Name} (${f.Type})`;
-    if (f.RelatedEntity) {
-        ret += ` (fkey to ${f.RelatedEntityBaseView})`;
-    }
-    return ret;
-}).join(',')}`
-
-        const fkeyFields = entityInfo.Fields.filter(f => f.RelatedEntity && f.RelatedEntity.length > 0);
-        const fkeyBaseViewsDistinct = fkeyFields.map(f => f.RelatedEntityBaseView).filter((v, i, a) => a.indexOf(v) === i);
-        const relationships: string = `
-In addition, ${entityInfo.BaseView} has links to other views, as shown here, you can use these views in sub-queries to achieve the request from the user.
-If there are multiple filters related to a single related view, attempt to combine them into a single sub-query for efficiency.
-${
-    // this part returns a list of all the related views and the fields that are related to the current view via fkeys in the current view
-    fkeyBaseViewsDistinct.map(v => {
-        if (processedViews.indexOf(v) === -1) {
-            const e = md.Entities.find(e => e.BaseView === v);
-            if (e) {
-                processedViews.push(v); // already processed this view now, so we won't repeat it
-                return `* ${e.SchemaName}.${e.BaseView}: ${e.Fields.map(ef => {
-                    return ef.Name + ' (' + ef.Type + ')';
-                }).join(',') }`
-            }
-            else
-                return '';    
-        }
-        else 
-            return ''; // already did this at some point
-    }).join('\n')
-}
-${
-    // this part returns a list of all the related views and the fields that are related to the current view fkeys in THOSE views
-    entityInfo.RelatedEntities.map(r => {
-        const e = md.Entities.find(e => e.Name === r.RelatedEntity);
-        if (e) {
-            if (processedViews.indexOf(e.BaseView) === -1) {
-                processedViews.push(e.BaseView); // note that we are processing this view now, so we won't repeat it
-                return `* ${e.SchemaName}.${e.BaseView}: ${e.Fields.map(ef => {
-                    let ret: string = `${ef.Name} (${ef.Type})`;
-                    if (ef.RelatedEntity) {
-                        ret += ` (fkey to ${ef.RelatedEntityBaseView})`;
-                    }
-                    return ret;
-                }).join(',') }`    
-            }
-            else
-                return ''; // already did this at some point
-        }
-        else
-            return '';
-    }).join('\n')
-}
-
-<IMPORTANT - LISTS FEATURE> 
-In addition to the above related views, a user may talk about "Lists" in their request. A List is a static set of records modeled in our database with the ${listsEntity.SchemaName}.vwLists view and 
-the ${listsEntity.SchemaName}.vwListDetails view. ${listsEntity.SchemaName}.vwLists contains the list "header" information with these columns:
-${listsEntity.Fields.map(f => {
-    return f.Name + ' (' + f.SQLFullType + ')';
-}).join(', ')}
-The vwListDetails view contains the list "detail" information with these columns which is basically the records that are part of the list. ${listsEntity.SchemaName}.vwListDetails contains these columns:
-${listDetailsEntity.Fields.map(f => {
-    return f.Name + ' (' + f.SQLFullType + ')';
-}).join(', ')}.
-
-If a user is asking to use a list in creating a view, you need to use a sub-query along these lines:
-
-ID IN (SELECT RecordID FROM ${listsEntity.SchemaName}.vwListDetails WHERE ListID='My List ID')
-
-In this example we're assuming the user has asked us to filter to include only records that are part of the list with the ID of 'My List ID'. In reality the prompt you will have will have a UUID/GUID type ID not a text string like this. 
-You can use any fields at the detail level filter the records and of course combine this type of list-oriented sub-query with other filters as appropriate to satisfy the user's request.
-
-It is also possible that a user will provide ONLY the name of the list they want to filter on. If they provide the List ID, use it with a query like the above. However, if ONLY a List name is provided, you can do as follows: use this style of query with a join to the vwLists view (the list "header") to filter on the name
-of the view or other header information if they want to filter on other list header attributes you can do this. Here is an example:
-
-ID IN (SELECT ld.RecordID FROM ${listsEntity.SchemaName}.vwListDetails ld INNER JOIN ${listsEntity.SchemaName}.vwLists l ON ld.ListID=l.ID WHERE l.Name='My List Name')
-
-No need to use table aliasing if you're just using the vwListDetails view, in that simple subquery it is automatic and unnecessary. If you need to join to the vwLists view, you can use the aliases "l" and "ld", as shown in the example above.
-
-</IMPORTANT - LISTS FEATURE>
-<IMPORTANT - OTHER VIEWS>
-The user might reference other "views" in their request. In the user's terminology a view is what we call a "User View" in MemberJunction system-speak. The idea is a user might ask for a filter that includes or excludes
-records from another view. Unlike Lists, which are STATIC sets of records, User Views are dynamic and can change based on the underlying data. So, what we need to do is use a sub-query that pulls in the SQL for the other view
-The user will be referring to the other view by name, so what you need to do when generating SQL for this scenario is to simply embed a sub-query along the lines of this example, updated of course in the context of the user's request and the rest of any filters you are building:
-    ID IN ({%UserView "ViewID"%}) -- this is for filtering the primary key using other User Views for this entity: "${entityInfo.Name}"
-    AccountID IN ({%UserView "ViewID"%}) -- this is an example where the foreign key relationship for the AccountID field in this entity (${entityInfo.Name}) links to another entity hypothetically called "Accounts" and we want to use an Accounts view for filtering in some way 
-By including this sub-query in your generated WHERE clause, it will give me what I need to dynamically replace the {%UserView "View Name"%} with the actual SQL for the view that the user is referring to. Since that actual SQL
-can change over time, I don't want to embed it directly here but rather have it templatized and each time it is run, I will pre-process the SQL to replace the template with the actual SQL for the view.
-</IMPORTANT - OTHER VIEWS>
-`
-
-        return gptSysPrompt + (processedViews.length > 1 /*we always have 1 from the entity base view*/ ? relationships : '') + `
-        **** REMEMBER **** I am a BOT, do not return anything other than JSON to me or I will choke on your response!`;
-    }    
-}