@memberjunction/server 0.9.20 → 0.9.22

package/dist/entitySubclasses/userViewEntity.server.js

@@ -0,0 +1,95 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserViewEntity_Server = void 0;
+const global_1 = require("@memberjunction/global");
+const core_1 = require("@memberjunction/core");
+const core_entities_1 = require("@memberjunction/core-entities");
+const ai_1 = require("@memberjunction/ai");
+let UserViewEntity_Server = class UserViewEntity_Server extends core_entities_1.UserViewEntityExtended {
+    get SmartFilterImplemented() {
+        return true;
+    }
+    async GenerateSmartFilterWhereClause(prompt, entityInfo) {
+        try {
+            const llm = new ai_1.OpenAILLM();
+            const chatParams = {
+                model: 'gpt-3.5-turbo',
+                systemPrompt: this.GenerateSysPrompt(entityInfo),
+                userMessage: '',
+                messages: [
+                    {
+                        role: 'user',
+                        content: `${prompt}`,
+                    },
+                ],
+            };
+            const result = await llm.ChatCompletion(chatParams);
+            if (result && result.data)
+                return result.data.choices[0].message.content;
+            else
+                throw new Error('No result returned from AI');
+        }
+        catch (e) {
+            (0, core_1.LogError)(e);
+            throw e;
+        }
+    }
+    GenerateSysPrompt(entityInfo) {
+        const md = new core_1.Metadata();
+        const gptSysPrompt = `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
+};
+
+The view that the user is querying is called ${entityInfo.BaseView} and has these fields:
+${entityInfo.Fields.map(f => {
+            let ret = `${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 = `
+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.
+${fkeyBaseViewsDistinct.map(v => {
+            const e = md.Entities.find(e => e.BaseView === v);
+            if (e)
+                return `* ${e.Name}: ${e.Fields.map(ef => ef.Name).join(',')}`;
+            else
+                return '';
+        }).join('\n')}
+${entityInfo.RelatedEntities.map(r => {
+            const e = md.Entities.find(e => e.Name === r.Entity);
+            if (e)
+                return `* ${e.Name}: ${e.Fields.map(ef => {
+                    let ret = `${ef.Name} (${ef.Type})`;
+                    if (ef.RelatedEntity) {
+                        ret += ` (fkey to ${ef.RelatedEntityBaseView})`;
+                    }
+                    return ret;
+                }).join(',')}`;
+            else
+                return '';
+        }).join('\n')}`;
+        return gptSysPrompt + (entityInfo.RelatedEntities.length > 0 || fkeyFields.length > 0 ? relationships : '');
+    }
+};
+UserViewEntity_Server = __decorate([
+    (0, global_1.RegisterClass)(core_1.BaseEntity, 'User Views', 3)
+], UserViewEntity_Server);
+exports.UserViewEntity_Server = UserViewEntity_Server;
+//# sourceMappingURL=userViewEntity.server.js.map

package/dist/entitySubclasses/userViewEntity.server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"userViewEntity.server.js","sourceRoot":"","sources":["../../src/entitySubclasses/userViewEntity.server.ts"],"names":[],"mappings":";;;;;;;;;AAAA,mDAAiE;AACjE,+CAAkF;AAClF,iEAAsE;AACtE,2CAAsF;AAG/E,IAAM,qBAAqB,GAA3B,MAAM,qBAAsB,SAAQ,sCAAsB;IAI7D,IAAuB,sBAAsB;QACzC,OAAO,IAAI,CAAC;IAChB,CAAC;IAOM,KAAK,CAAC,8BAA8B,CAAC,MAAc,EAAE,UAAsB;QAC9E,IAAI;YACA,MAAM,GAAG,GAAW,IAAI,cAAS,EAAE,CAAC;YAEpC,MAAM,UAAU,GAAe;gBAC3B,KAAK,EAAE,eAAe;gBACtB,YAAY,EAAE,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC;gBAChD,WAAW,EAAE,EAAE;gBACf,QAAQ,EAAE;oBACV;wBACI,IAAI,EAAE,MAAM;wBACZ,OAAO,EAAE,GAAG,MAAM,EAAE;qBACrB;iBACF;aACJ,CAAA;YACD,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;YACpD,IAAI,MAAM,IAAI,MAAM,CAAC,IAAI;gBACrB,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;;gBAE9C,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;SACrD;QACD,OAAO,CAAC,EAAE;YACN,IAAA,eAAQ,EAAC,CAAC,CAAC,CAAC;YACZ,MAAM,CAAC,CAAC;SACX;IACL,CAAC;IAEM,iBAAiB,CAAC,UAAsB;QAC3C,MAAM,EAAE,GAAG,IAAI,eAAQ,EAAE,CAAC;QAC1B,MAAM,YAAY,GAAW;;;;;;;;;;+CAUU,UAAU,CAAC,QAAQ;EAChE,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;YACxB,IAAI,GAAG,GAAW,GAAG,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,GAAG,CAAC;YAC1C,IAAI,CAAC,CAAC,aAAa,EAAE;gBACjB,GAAG,IAAI,aAAa,CAAC,CAAC,qBAAqB,GAAG,CAAC;aAClD;YACD,OAAO,GAAG,CAAC;QACf,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAA;QAEN,MAAM,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,IAAI,CAAC,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAChG,MAAM,qBAAqB,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QACnH,MAAM,aAAa,GAAW;eACvB,UAAU,CAAC,QAAQ;;EAI9B,qBAAqB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;YAC1B,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,CAAC,CAAC,CAAC;YAClD,IAAI,CAAC;gBACD,OAAO,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAE,EAAE,CAAA;;gBAE/D,OAAO,EAAE,CAAC;QAClB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAChB;EAGI,UAAU,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;YAC/B,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC;YACrD,IAAI,CAAC;gBACD,OAAO,KAAK,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;oBACrC,IAAI,GAAG,GAAW,GAAG,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC,IAAI,GAAG,CAAC;oBAC5C,IAAI,EAAE,CAAC,aAAa,EAAE;wBAClB,GAAG,IAAI,aAAa,EAAE,CAAC,qBAAqB,GAAG,CAAC;qBACnD;oBACD,OAAO,GAAG,CAAC;gBACf,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAE,EAAE,CAAA;;gBAEf,OAAO,EAAE,CAAC;QAClB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAChB,EAAE,CAAA;QAEM,OAAO,YAAY,GAAG,CAAC,UAAU,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAChH,CAAC;CACJ,CAAA;AA/FY,qBAAqB;IADjC,IAAA,sBAAa,EAAC,iBAAU,EAAE,YAAY,EAAE,CAAC,CAAC;GAC9B,qBAAqB,CA+FjC;AA/FY,sDAAqB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memberjunction/server",
-  "version": "0.9.20",
+  "version": "0.9.22",
   "description": "MemberJunction: This project provides API access via GraphQL to the common data store.",
   "main": "dist/index.js",
   "types": "src/index.ts",
@@ -21,12 +21,12 @@
   "dependencies": {
     "@apollo/server": "^4.9.1",
     "@graphql-tools/utils": "^10.0.1",
-    "@memberjunction/ai": "^0.9.33",
-    "@memberjunction/core": "^0.9.36",
-    "@memberjunction/core-entities": "^0.9.9",
-    "@memberjunction/global": "^0.9.35",
-    "@memberjunction/queue": "^0.9.33",
-    "@memberjunction/sqlserver-dataprovider": "^0.9.33",
+    "@memberjunction/ai": "^0.9.35",
+    "@memberjunction/core": "^0.9.38",
+    "@memberjunction/core-entities": "^0.9.11",
+    "@memberjunction/global": "^0.9.37",
+    "@memberjunction/queue": "^0.9.35",
+    "@memberjunction/sqlserver-dataprovider": "^0.9.35",
     "@types/axios": "^0.14.0",
     "@types/cors": "^2.8.13",
     "@types/jsonwebtoken": "^8.5.9",

package/src/entitySubclasses/userViewEntity.server.ts

@@ -0,0 +1,102 @@
+import { MJGlobal, RegisterClass } from "@memberjunction/global";
+import { BaseEntity, EntityInfo, LogError, Metadata } from "@memberjunction/core";
+import { UserViewEntityExtended } from '@memberjunction/core-entities'
+import { BaseLLM, BaseModel, ChatParams, IChat, OpenAILLM } from "@memberjunction/ai";
+
+@RegisterClass(BaseEntity, 'User Views', 3) // high priority to ensure this is used ahead of the UserViewEntityExtended in the @memberjunction/core-entities package (which has priority of 2)
+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;
+    }
+
+    /**
+     * 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<string> {
+        try {
+            const llm = <IChat> new OpenAILLM(); // for now, hardcoded to use OpenAI
+
+            const chatParams: ChatParams = {
+                model: 'gpt-3.5-turbo',
+                systemPrompt: this.GenerateSysPrompt(entityInfo),
+                userMessage: '',
+                messages: [      
+                {
+                    role: 'user',
+                    content: `${prompt}`,
+                  },
+                ],
+            }
+            const result = await llm.ChatCompletion(chatParams);
+            if (result && result.data)
+                return result.data.choices[0].message.content;
+            else
+                throw new Error('No result returned from AI');
+        }
+        catch (e) {
+            LogError(e);
+            throw e;
+        }
+    }
+
+    public GenerateSysPrompt(entityInfo: EntityInfo): string {
+        const md = new Metadata();
+        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
+};
+
+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 => {
+        const e = md.Entities.find(e => e.BaseView === v);
+        if (e) 
+            return `* ${e.Name}: ${e.Fields.map(ef => ef.Name).join(',') }`
+        else
+            return '';
+    }).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.Entity);
+        if (e) 
+            return `* ${e.Name}: ${e.Fields.map(ef => {
+                let ret: string = `${ef.Name} (${ef.Type})`;
+                if (ef.RelatedEntity) {
+                    ret += ` (fkey to ${ef.RelatedEntityBaseView})`;
+                }
+                return ret;
+            }).join(',') }`
+        else
+            return '';
+    }).join('\n')
+}`
+
+        return gptSysPrompt + (entityInfo.RelatedEntities.length > 0 || fkeyFields.length > 0 ? relationships : '');
+    }    
+}

package/dist/entitySubclasses/userViewEntity_Server.js

@@ -1,19 +0,0 @@
-"use strict";
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UserViewEntity_Server = void 0;
-const global_1 = require("@memberjunction/global");
-const core_1 = require("@memberjunction/core");
-const core_entities_1 = require("@memberjunction/core-entities");
-let UserViewEntity_Server = class UserViewEntity_Server extends core_entities_1.UserViewEntityExtended {
-};
-UserViewEntity_Server = __decorate([
-    (0, global_1.RegisterClass)(core_1.BaseEntity, 'User Views', -1)
-], UserViewEntity_Server);
-exports.UserViewEntity_Server = UserViewEntity_Server;
-//# sourceMappingURL=userViewEntity_Server.js.map

package/dist/entitySubclasses/userViewEntity_Server.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"userViewEntity_Server.js","sourceRoot":"","sources":["../../src/entitySubclasses/userViewEntity_Server.ts"],"names":[],"mappings":";;;;;;;;;AAAA,mDAAuD;AACvD,+CAAkD;AAClD,iEAAsE;AAG/D,IAAM,qBAAqB,GAA3B,MAAM,qBAAsB,SAAQ,sCAAsB;CAEhE,CAAA;AAFY,qBAAqB;IADjC,IAAA,sBAAa,EAAC,iBAAU,EAAE,YAAY,EAAE,CAAC,CAAC,CAAC;GAC/B,qBAAqB,CAEjC;AAFY,sDAAqB"}

package/src/entitySubclasses/userViewEntity_Server.ts

@@ -1,8 +0,0 @@
-import { RegisterClass } from "@memberjunction/global";
-import { BaseEntity } from "@memberjunction/core";
-import { UserViewEntityExtended } from '@memberjunction/core-entities'
-
-@RegisterClass(BaseEntity, 'User Views', -1) // -1 priority because we want the generated UserViewEntity class to be used ahead of this and it gets generated with a priority of 0 by default
-export class UserViewEntity_Server extends UserViewEntityExtended  {
-
-}