@memberjunction/server 0.9.244 → 0.9.246

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memberjunction/server",
-  "version": "0.9.244",
+  "version": "0.9.246",
   "description": "MemberJunction: This project provides API access via GraphQL to the common data store.",
   "main": "dist/index.js",
   "types": "src/index.ts",
@@ -22,16 +22,16 @@
     "@apollo/server": "^4.9.1",
     "@graphql-tools/utils": "^10.0.1",
     "@memberjunction/ai": "^0.9.163",
-    "@memberjunction/aiengine": "^0.9.65",
+    "@memberjunction/aiengine": "^0.9.67",
     "@memberjunction/core": "^0.9.177",
-    "@memberjunction/core-entities": "^0.9.164",
-    "@memberjunction/data-context": "^0.9.51",
-    "@memberjunction/data-context-server": "^0.9.47",
+    "@memberjunction/core-entities": "^0.9.166",
+    "@memberjunction/data-context": "^0.9.53",
+    "@memberjunction/data-context-server": "^0.9.49",
     "@memberjunction/global": "^0.9.156",
-    "@memberjunction/storage": "^0.9.9",
-    "@memberjunction/queue": "^0.9.186",
-    "@memberjunction/sqlserver-dataprovider": "^0.9.201",
-    "@memberjunction/skip-types": "^0.9.76",
+    "@memberjunction/storage": "^0.9.11",
+    "@memberjunction/queue": "^0.9.188",
+    "@memberjunction/sqlserver-dataprovider": "^0.9.203",
+    "@memberjunction/skip-types": "^0.9.78",
     "@types/cors": "^2.8.13",
     "@types/jsonwebtoken": "^8.5.9",
     "@types/node": "^18.11.14",

package/src/generated/generated.ts

@@ -2,7 +2,7 @@
 * ALL ENTITIES - TypeGraphQL Type Class Definition - AUTO GENERATED FILE
 * Generated Entities and Resolvers for Server
 * 
-* GENERATED: 3/23/2024, 10:15:37 AM
+* GENERATED: 3/23/2024, 4:22:49 PM
 * 
 *   >>> DO NOT MODIFY THIS FILE!!!!!!!!!!!!
 *   >>> YOUR CHANGES WILL BE OVERWRITTEN
@@ -26,7 +26,7 @@ import { CompanyEntity, EmployeeEntity, UserFavoriteEntity, EmployeeCompanyInteg
 //****************************************************************************
 // ENTITY CLASS for Companies
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'A list of organizational units within your business. These can be subsidiaries or divisions or other units. Companies are used to organizae employee records and also for separating integrations if you have multiple integrations of the same type of system.' })
 export class Company_ {  
     @Field(() => Int) 
     ID: number;
@@ -292,7 +292,7 @@ export class CompanyResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for Employees
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'A list of employees across all units of your organization' })
 export class Employee_ {  
     @Field(() => Int) 
     ID: number;
@@ -620,7 +620,7 @@ export class EmployeeResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for User Favorites
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'Records that each user can mark as a favorite for easy access' })
 export class UserFavorite_ {  
     @Field(() => Int) 
     ID: number;
@@ -1228,7 +1228,7 @@ export class EmployeeSkillResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for Roles
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'Roles are used for security administration and can have zero to many Users as members' })
 export class Role_ {  
     @Field(() => Int) 
     ID: number;
@@ -1273,6 +1273,25 @@ export class Role_ {
 
 }
         
+//****************************************************************************
+// INPUT TYPE for Roles   
+//****************************************************************************
+@InputType()
+export class CreateRoleInput {
+    @Field()
+    Name: string;
+
+    @Field({ nullable: true })
+    Description: string;
+
+    @Field({ nullable: true })
+    DirectoryID: string;
+
+    @Field({ nullable: true })
+    SQLName: string;
+}
+
+        
 //****************************************************************************
 // INPUT TYPE for Roles   
 //****************************************************************************
@@ -1394,6 +1413,36 @@ export class RoleResolver extends ResolverBase {
         return result;
     }
     
+    @Mutation(() => Role_)
+    async CreateRole(
+        @Arg('input', () => CreateRoleInput) input: CreateRoleInput,
+        @Ctx() { dataSource, userPayload }: AppContext, 
+        @PubSub() pubSub: PubSubEngine
+    ) {
+        if (await this.BeforeCreate(dataSource, input)) { // fire event and proceed if it wasn't cancelled
+            const entityObject = <RoleEntity>await new Metadata().GetEntityObject('Roles', this.GetUserFromPayload(userPayload));
+            await entityObject.NewRecord();
+            entityObject.SetMany(input);
+            if (await entityObject.Save()) {
+                // save worked, fire the AfterCreate event and then return all the data
+                await this.AfterCreate(dataSource, input); // fire event
+                return entityObject.GetAll();
+            }
+            else 
+                // save failed, return null
+                return null;
+        }
+        else    
+            return null;
+    }
+
+    // Before/After CREATE Event Hooks for Sub-Classes to Override
+    protected async BeforeCreate(dataSource: DataSource, input: CreateRoleInput): Promise<boolean> {
+        return true;
+    }
+    protected async AfterCreate(dataSource: DataSource, input: CreateRoleInput) {
+    }
+    
     @Mutation(() => Role_)
     async UpdateRole(
         @Arg('input', () => UpdateRoleInput) input: UpdateRoleInput,
@@ -1425,12 +1474,38 @@ export class RoleResolver extends ResolverBase {
         const i = input, d = dataSource; // prevent error
     }
 
+    @Mutation(() => Role_)
+    async DeleteRole(@Arg('ID', () => Int) ID: number, @Ctx() { dataSource, userPayload }: AppContext, @PubSub() pubSub: PubSubEngine) {
+        if (await this.BeforeDelete(dataSource, ID)) { // fire event and proceed if it wasn't cancelled
+            const entityObject = <RoleEntity>await new Metadata().GetEntityObject('Roles', this.GetUserFromPayload(userPayload));
+            await entityObject.Load(ID);
+            const returnValue = entityObject.GetAll(); // grab the values before we delete so we can return last state before delete if we are successful.
+            if (await entityObject.Delete()) {
+                await this.AfterDelete(dataSource, ID); // fire event
+                return returnValue;
+            }
+            else 
+                return null; // delete failed, this will cause an exception
+        }
+        else
+            return null; // BeforeDelete canceled the operation, this will cause an exception
+    }
+
+    // Before/After UPDATE Event Hooks for Sub-Classes to Override
+    protected async BeforeDelete(dataSource: DataSource, ID: number): Promise<boolean> {
+        const i = ID, d = dataSource; // prevent error;
+        return true;
+    }
+    protected async AfterDelete(dataSource: DataSource, ID: number) {
+        const i = ID, d = dataSource; // prevent error
+    }
+
 }
 
 //****************************************************************************
 // ENTITY CLASS for Skills
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'A hierarchical list of possible skills that are linked to Employees and can also be linked to any other entity' })
 export class Skill_ {  
     @Field(() => Int) 
     ID: number;
@@ -1542,7 +1617,7 @@ export class SkillResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for Integration URL Formats
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'Used to generate web links for end users to easily access resources in a source system. URL Formats support templating to inject various field values at run-time to take a user directly to a resource in a source system.' })
 export class IntegrationURLFormat_ {  
     @Field(() => Int) 
     ID: number;
@@ -1689,7 +1764,7 @@ export class IntegrationURLFormatResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for Integrations
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'Catalog of all integrations that have been configured in the system.' })
 export class Integration_ {  
     @Field(() => Int) 
     ID: number;
@@ -1878,7 +1953,7 @@ export class IntegrationResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for Company Integrations
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'Links individual company records to specific integrations' })
 export class CompanyIntegration_ {  
     @Field(() => Int) 
     ID: number;
@@ -2149,7 +2224,7 @@ export class CompanyIntegrationResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for Entity Fields
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'List of all fields within each entity with metadata about each field' })
 export class EntityField_ {  
     @Field(() => Int) 
     ID: number;
@@ -2642,7 +2717,7 @@ export class EntityFieldResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for Entities
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'Catalog of all entities across all schemas' })
 export class Entity_ {  
     @Field(() => Int) 
     ID: number;
@@ -3492,7 +3567,7 @@ export class EntityResolverBase extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for Users
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'A list of all users who have or had access to the system' })
 export class User_ {  
     @Field(() => Int) 
     ID: number;
@@ -4003,7 +4078,7 @@ export class UserResolverBase extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for Entity Relationships
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'Metadata about relationships between entities including display preferences for the UI' })
 export class EntityRelationship_ {  
     @Field(() => Int) 
     ID: number;
@@ -4524,7 +4599,7 @@ export class UserRecordLogResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for User Views
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'Views are sets of records within a given entity defined by filtering rules. Views can be used programatically to retrieve dynamic sets of data and in user interfaces like MJ Explorer for end-user consumption.' })
 export class UserView_ {  
     @Field(() => Int) 
     ID: number;
@@ -5427,7 +5502,7 @@ export class ErrorLogResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for Applications
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'Applications are used to group entities in the user interface for ease of user access' })
 export class Application_ {  
     @Field(() => Int) 
     ID: number;
@@ -5583,7 +5658,7 @@ export class ApplicationResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for Application Entities
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'List of entities within each application. An application can have any number of entities and an entity can be part of any number of applications.' })
 export class ApplicationEntity_ {  
     @Field(() => Int) 
     ID: number;
@@ -5819,7 +5894,7 @@ export class ApplicationEntityResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for Entity Permissions
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'Security settings for each entity' })
 export class EntityPermission_ {  
     @Field(() => Int) 
     ID: number;
@@ -6638,7 +6713,7 @@ export class CompanyIntegrationRunAPILogResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for Lists
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'Static lists are useful for controlling a set of data for a given entity. These can be used programatically for applications like logging and tracking long-running tasks and also by end users for tracking any particular list of records they want to directly control the set.' })
 export class List_ {  
     @Field(() => Int) 
     ID: number;
@@ -6888,7 +6963,7 @@ export class ListResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for List Details
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'Tracks the records within each list.' })
 export class ListDetail_ {  
     @Field(() => Int) 
     ID: number;
@@ -7083,7 +7158,7 @@ export class ListDetailResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for User View Runs
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'User Views can be logged when run to capture the date and user that ran the view as well as the output results.' })
 export class UserViewRun_ {  
     @Field(() => Int) 
     ID: number;
@@ -7271,7 +7346,7 @@ export class UserViewRunResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for User View Run Details
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'Tracks the set of records that were included in each run of a given user view.' })
 export class UserViewRunDetail_ {  
     @Field(() => Int) 
     ID: number;
@@ -7908,7 +7983,7 @@ export class WorkflowEngineResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for Record Changes
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'For entities that have TrackRecordChanges=1, Record Changes will store the history of all changes made within the system. For integrations you can directly add values here if you have inbound signals indicating records were changed in a source system. This entity only automatically captures Record Changes if they were made within the system.' })
 export class RecordChange_ {  
     @Field(() => Int) 
     ID: number;
@@ -9018,7 +9093,7 @@ export class EntityFieldValueResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for AI Models
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'Catalog of all AI Models configured in the system.' })
 export class AIModel_ {  
     @Field(() => Int) 
     ID: number;
@@ -9228,7 +9303,7 @@ export class AIModelResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for AI Actions
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'List of all actions that are possible across all AI Models' })
 export class AIAction_ {  
     @Field(() => Int) 
     ID: number;
@@ -9405,7 +9480,7 @@ export class AIActionResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for AI Model Actions
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'Tracks the actions supported by each AI Model' })
 export class AIModelAction_ {  
     @Field(() => Int) 
     ID: number;
@@ -9551,7 +9626,7 @@ export class AIModelActionResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for Entity AI Actions
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'Tracks the AI actions that should be invoked based on changes to records within a given entity.' })
 export class EntityAIAction_ {  
     @Field(() => Int) 
     ID: number;
@@ -9755,7 +9830,7 @@ export class EntityAIActionResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for AI Model Types
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'Types of AI Models' })
 export class AIModelType_ {  
     @Field(() => Int) 
     ID: number;
@@ -9983,7 +10058,7 @@ export class QueueTypeResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for Queues
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'Queues can be used to async execute long running tasks' })
 export class Queue_ {  
     @Field(() => Int) 
     ID: number;
@@ -10528,7 +10603,7 @@ export class QueueTaskResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for Dashboards
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'Dashboards are used to group resources into a single display pane for an end-user' })
 export class Dashboard_ {  
     @Field(() => Int) 
     ID: number;
@@ -11676,7 +11751,7 @@ export class ResourceTypeResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for Tags
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'Tags are used to arbitrarily associate any record in any entity with addtional information.' })
 export class Tag_ {  
     @Field(() => Int) 
     ID: number;
@@ -11780,7 +11855,7 @@ export class TagResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for Tagged Items
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'Tracks the links between any record in any entity with Tags' })
 export class TaggedItem_ {  
     @Field(() => Int) 
     ID: number;
@@ -11862,7 +11937,7 @@ export class TaggedItemResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for Workspaces
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'A user can have one or more workspaces' })
 export class Workspace_ {  
     @Field(() => Int) 
     ID: number;
@@ -12073,7 +12148,7 @@ export class WorkspaceResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for Workspace Items
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'Tracks the resources that are active within a given worksapce' })
 export class WorkspaceItem_ {  
     @Field(() => Int) 
     ID: number;
@@ -12314,7 +12389,7 @@ export class WorkspaceItemResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for Datasets
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'Cacheable sets of data that can span one or more items' })
 export class Dataset_ {  
     @Field(() => Int) 
     ID: number;
@@ -12403,7 +12478,7 @@ export class DatasetResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for Dataset Items
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'A single item in a Dataset and can be sourced from multiple methods.' })
 export class DatasetItem_ {  
     @Field(() => Int) 
     ID: number;
@@ -13290,7 +13365,7 @@ export class UserNotificationResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for Schema Info
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: 'Tracks the schemas in the system and the ID ranges that are valid for entities within each schema.' })
 export class SchemaInfo_ {  
     @Field(() => Int) 
     ID: number;
@@ -14615,7 +14690,7 @@ export class QueryCategoryResolver extends ResolverBase {
 //****************************************************************************
 // ENTITY CLASS for Queries
 //****************************************************************************
-@ObjectType()
+@ObjectType({ description: '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 class Query_ {  
     @Field(() => Int) 
     ID: number;