@memberjunction/server 3.4.0 → 4.1.0

package/dist/rest/EntityCRUDHandler.js

@@ -1,16 +1,27 @@
 import { CompositeKey, EntityPermissionType, EntitySaveOptions, LogError, Metadata } from '@memberjunction/core';
+/**
+ * Entity CRUD Implementation Functions for REST endpoints
+ * These functions contain the detailed implementation for entity operations
+ */
 export class EntityCRUDHandler {
+    /**
+     * Create a new entity
+     */
     static async createEntity(entityName, data, user) {
         try {
+            // Get entity object
             const md = new Metadata();
             const entity = await md.GetEntityObject(entityName, user);
+            // Check permissions
             if (!entity.CheckPermissions(EntityPermissionType.Create, false)) {
                 return {
                     success: false,
                     error: `User ${user.Name} does not have permission to create ${entityName} records`
                 };
             }
+            // Create new record
             entity.NewRecord();
+            // Extract save options if provided
             const options = new EntitySaveOptions();
             if (data.options) {
                 const { IgnoreDirtyState, SkipEntityAIActions, SkipEntityActions, ReplayOnly, SkipOldValuesCheck } = data.options;
@@ -24,11 +35,14 @@ export class EntityCRUDHandler {
                     options.ReplayOnly = !!ReplayOnly;
                 if (SkipOldValuesCheck !== undefined)
                     options.SkipOldValuesCheck = !!SkipOldValuesCheck;
+                // Remove options from data
                 delete data.options;
             }
+            // Set values on the entity
             for (const key in data) {
                 entity.Set(key, data[key]);
             }
+            // Validate entity
             const validationResult = entity.Validate();
             if (!validationResult.Success) {
                 return {
@@ -37,6 +51,7 @@ export class EntityCRUDHandler {
                     validationErrors: validationResult.Errors
                 };
             }
+            // Save entity
             const saveSuccess = await entity.Save(options);
             if (!saveSuccess) {
                 const latestResult = entity.LatestResult;
@@ -46,6 +61,7 @@ export class EntityCRUDHandler {
                     details: latestResult
                 };
             }
+            // Get entity data for response
             const entityData = await entity.GetDataObject();
             return { success: true, entity: entityData };
         }
@@ -54,17 +70,24 @@ export class EntityCRUDHandler {
             return { success: false, error: error?.message || 'Unknown error' };
         }
     }
+    /**
+     * Read an entity by ID
+     */
     static async getEntity(entityName, id, relatedEntities = null, user) {
         try {
+            // Get entity object
             const md = new Metadata();
             const entity = await md.GetEntityObject(entityName, user);
+            // Check permissions
             if (!entity.CheckPermissions(EntityPermissionType.Read, false)) {
                 return {
                     success: false,
                     error: `User ${user.Name} does not have permission to read ${entityName} records`
                 };
             }
+            // Create composite key
             const compositeKey = this.createCompositeKeyFromId(entity, id);
+            // Load entity
             const loadSuccess = await entity.InnerLoad(compositeKey, relatedEntities);
             if (!loadSuccess) {
                 return {
@@ -72,6 +95,7 @@ export class EntityCRUDHandler {
                     error: `${entityName} with ID ${id} not found`
                 };
             }
+            // Get entity data for response
             const entityData = await entity.GetDataObject();
             return { success: true, entity: entityData };
         }
@@ -80,17 +104,24 @@ export class EntityCRUDHandler {
             return { success: false, error: error?.message || 'Unknown error' };
         }
     }
+    /**
+     * Update an existing entity
+     */
     static async updateEntity(entityName, id, data, user) {
         try {
+            // Get entity object
             const md = new Metadata();
             const entity = await md.GetEntityObject(entityName, user);
+            // Check permissions
             if (!entity.CheckPermissions(EntityPermissionType.Update, false)) {
                 return {
                     success: false,
                     error: `User ${user.Name} does not have permission to update ${entityName} records`
                 };
             }
+            // Create composite key
             const compositeKey = this.createCompositeKeyFromId(entity, id);
+            // Load entity
             const loadSuccess = await entity.InnerLoad(compositeKey);
             if (!loadSuccess) {
                 return {
@@ -98,6 +129,7 @@ export class EntityCRUDHandler {
                     error: `${entityName} with ID ${id} not found`
                 };
             }
+            // Extract save options if provided
             const options = new EntitySaveOptions();
             if (data.options) {
                 const { IgnoreDirtyState, SkipEntityAIActions, SkipEntityActions, ReplayOnly, SkipOldValuesCheck } = data.options;
@@ -111,15 +143,20 @@ export class EntityCRUDHandler {
                     options.ReplayOnly = !!ReplayOnly;
                 if (SkipOldValuesCheck !== undefined)
                     options.SkipOldValuesCheck = !!SkipOldValuesCheck;
+                // Remove options from data
                 delete data.options;
             }
+            // Update entity with new values
             for (const key in data) {
                 entity.Set(key, data[key]);
             }
+            // Check if entity is dirty
             if (!entity.Dirty && !options.IgnoreDirtyState) {
+                // Nothing changed, return success
                 const entityData = await entity.GetDataObject();
                 return { success: true, entity: entityData };
             }
+            // Validate entity
             const validationResult = entity.Validate();
             if (!validationResult.Success) {
                 return {
@@ -128,6 +165,7 @@ export class EntityCRUDHandler {
                     validationErrors: validationResult.Errors
                 };
             }
+            // Save entity
             const saveSuccess = await entity.Save(options);
             if (!saveSuccess) {
                 const latestResult = entity.LatestResult;
@@ -137,6 +175,7 @@ export class EntityCRUDHandler {
                     details: latestResult
                 };
             }
+            // Get entity data for response
             const entityData = await entity.GetDataObject();
             return { success: true, entity: entityData };
         }
@@ -145,17 +184,24 @@ export class EntityCRUDHandler {
             return { success: false, error: error?.message || 'Unknown error' };
         }
     }
+    /**
+     * Delete an entity
+     */
     static async deleteEntity(entityName, id, options, user) {
         try {
+            // Get entity object
             const md = new Metadata();
             const entity = await md.GetEntityObject(entityName, user);
+            // Check permissions
             if (!entity.CheckPermissions(EntityPermissionType.Delete, false)) {
                 return {
                     success: false,
                     error: `User ${user.Name} does not have permission to delete ${entityName} records`
                 };
             }
+            // Create composite key
             const compositeKey = this.createCompositeKeyFromId(entity, id);
+            // Load entity
             const loadSuccess = await entity.InnerLoad(compositeKey);
             if (!loadSuccess) {
                 return {
@@ -163,6 +209,7 @@ export class EntityCRUDHandler {
                     error: `${entityName} with ID ${id} not found`
                 };
             }
+            // Delete the entity
             const deleteSuccess = await entity.Delete(options);
             if (!deleteSuccess) {
                 const latestResult = entity.LatestResult;
@@ -179,17 +226,25 @@ export class EntityCRUDHandler {
             return { success: false, error: error?.message || 'Unknown error' };
         }
     }
+    /**
+     * Helper method to create a composite key from an ID
+     */
     static createCompositeKeyFromId(entity, id) {
         if (entity.EntityInfo.PrimaryKeys.length === 1) {
+            // Single primary key
             const primaryKeyField = entity.EntityInfo.PrimaryKeys[0].Name;
             const compositeKey = new CompositeKey();
             const strId = id.toString();
+            // Use key-value pairs instead of SetValue
             compositeKey.KeyValuePairs = [
                 { FieldName: primaryKeyField, Value: strId }
             ];
             return compositeKey;
         }
         else {
+            // Composite primary key - this is a simplification
+            // In a real implementation, you would need to parse a composite ID string
+            // or accept an object with all primary key values
             throw new Error('Composite primary keys are not supported in this simplified implementation');
         }
     }

package/dist/rest/EntityCRUDHandler.js.map

@@ -1 +1 @@
-{"version":3,"file":"EntityCRUDHandler.js","sourceRoot":"","sources":["../../src/rest/EntityCRUDHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EACS,YAAY,EAAuB,oBAAoB,EACnE,iBAAiB,EAAE,QAAQ,EAAE,QAAQ,EACxC,MAAM,sBAAsB,CAAC;AAM9B,MAAM,OAAO,iBAAiB;IAI1B,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,UAAkB,EAAE,IAAS,EAAE,IAAc;QACnE,IAAI,CAAC;YAED,MAAM,EAAE,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC1B,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,eAAe,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YAG1D,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC;gBAC/D,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,QAAQ,IAAI,CAAC,IAAI,uCAAuC,UAAU,UAAU;iBACtF,CAAC;YACN,CAAC;YAGD,MAAM,CAAC,SAAS,EAAE,CAAC;YAGnB,MAAM,OAAO,GAAG,IAAI,iBAAiB,EAAE,CAAC;YACxC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACf,MAAM,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,UAAU,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;gBAClH,IAAI,gBAAgB,KAAK,SAAS;oBAAE,OAAO,CAAC,gBAAgB,GAAG,CAAC,CAAC,gBAAgB,CAAC;gBAClF,IAAI,mBAAmB,KAAK,SAAS;oBAAE,OAAO,CAAC,mBAAmB,GAAG,CAAC,CAAC,mBAAmB,CAAC;gBAC3F,IAAI,iBAAiB,KAAK,SAAS;oBAAE,OAAO,CAAC,iBAAiB,GAAG,CAAC,CAAC,iBAAiB,CAAC;gBACrF,IAAI,UAAU,KAAK,SAAS;oBAAE,OAAO,CAAC,UAAU,GAAG,CAAC,CAAC,UAAU,CAAC;gBAChE,IAAI,kBAAkB,KAAK,SAAS;oBAAE,OAAO,CAAC,kBAAkB,GAAG,CAAC,CAAC,kBAAkB,CAAC;gBAGxF,OAAO,IAAI,CAAC,OAAO,CAAC;YACxB,CAAC;YAGD,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACrB,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YAC/B,CAAC;YAGD,MAAM,gBAAgB,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC3C,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC;gBAC5B,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,mBAAmB;oBAC1B,gBAAgB,EAAE,gBAAgB,CAAC,MAAM;iBAC5C,CAAC;YACN,CAAC;YAGD,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAE/C,IAAI,CAAC,WAAW,EAAE,CAAC;gBACf,MAAM,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;gBACzC,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,YAAY,EAAE,OAAO,IAAI,yBAAyB;oBACzD,OAAO,EAAE,YAAY;iBACxB,CAAC;YACN,CAAC;YAGD,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,aAAa,EAAE,CAAC;YAChD,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;QACjD,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YAClB,QAAQ,CAAC,KAAK,CAAC,CAAC;YAChB,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,IAAI,eAAe,EAAE,CAAC;QACxE,CAAC;IACL,CAAC;IAKD,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,UAAkB,EAAE,EAAmB,EAAE,kBAA4B,IAAI,EAAE,IAAc;QAC5G,IAAI,CAAC;YAED,MAAM,EAAE,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC1B,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,eAAe,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YAG1D,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC;gBAC7D,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,QAAQ,IAAI,CAAC,IAAI,qCAAqC,UAAU,UAAU;iBACpF,CAAC;YACN,CAAC;YAGD,MAAM,YAAY,GAAG,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAG/D,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;YAE1E,IAAI,CAAC,WAAW,EAAE,CAAC;gBACf,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,GAAG,UAAU,YAAY,EAAE,YAAY;iBACjD,CAAC;YACN,CAAC;YAGD,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,aAAa,EAAE,CAAC;YAChD,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;QACjD,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YAClB,QAAQ,CAAC,KAAK,CAAC,CAAC;YAChB,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,IAAI,eAAe,EAAE,CAAC;QACxE,CAAC;IACL,CAAC;IAKD,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,UAAkB,EAAE,EAAmB,EAAE,IAAS,EAAE,IAAc;QACxF,IAAI,CAAC;YAED,MAAM,EAAE,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC1B,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,eAAe,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YAG1D,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC;gBAC/D,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,QAAQ,IAAI,CAAC,IAAI,uCAAuC,UAAU,UAAU;iBACtF,CAAC;YACN,CAAC;YAGD,MAAM,YAAY,GAAG,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAG/D,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;YAEzD,IAAI,CAAC,WAAW,EAAE,CAAC;gBACf,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,GAAG,UAAU,YAAY,EAAE,YAAY;iBACjD,CAAC;YACN,CAAC;YAGD,MAAM,OAAO,GAAG,IAAI,iBAAiB,EAAE,CAAC;YACxC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACf,MAAM,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,UAAU,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;gBAClH,IAAI,gBAAgB,KAAK,SAAS;oBAAE,OAAO,CAAC,gBAAgB,GAAG,CAAC,CAAC,gBAAgB,CAAC;gBAClF,IAAI,mBAAmB,KAAK,SAAS;oBAAE,OAAO,CAAC,mBAAmB,GAAG,CAAC,CAAC,mBAAmB,CAAC;gBAC3F,IAAI,iBAAiB,KAAK,SAAS;oBAAE,OAAO,CAAC,iBAAiB,GAAG,CAAC,CAAC,iBAAiB,CAAC;gBACrF,IAAI,UAAU,KAAK,SAAS;oBAAE,OAAO,CAAC,UAAU,GAAG,CAAC,CAAC,UAAU,CAAC;gBAChE,IAAI,kBAAkB,KAAK,SAAS;oBAAE,OAAO,CAAC,kBAAkB,GAAG,CAAC,CAAC,kBAAkB,CAAC;gBAGxF,OAAO,IAAI,CAAC,OAAO,CAAC;YACxB,CAAC;YAGD,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACrB,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YAC/B,CAAC;YAGD,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;gBAE7C,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,aAAa,EAAE,CAAC;gBAChD,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;YACjD,CAAC;YAGD,MAAM,gBAAgB,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC3C,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC;gBAC5B,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,mBAAmB;oBAC1B,gBAAgB,EAAE,gBAAgB,CAAC,MAAM;iBAC5C,CAAC;YACN,CAAC;YAGD,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAE/C,IAAI,CAAC,WAAW,EAAE,CAAC;gBACf,MAAM,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;gBACzC,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,YAAY,EAAE,OAAO,IAAI,yBAAyB;oBACzD,OAAO,EAAE,YAAY;iBACxB,CAAC;YACN,CAAC;YAGD,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,aAAa,EAAE,CAAC;YAChD,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;QACjD,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YAClB,QAAQ,CAAC,KAAK,CAAC,CAAC;YAChB,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,IAAI,eAAe,EAAE,CAAC;QACxE,CAAC;IACL,CAAC;IAKD,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,UAAkB,EAAE,EAAmB,EAAE,OAA4B,EAAE,IAAc;QAC3G,IAAI,CAAC;YAED,MAAM,EAAE,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC1B,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,eAAe,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YAG1D,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC;gBAC/D,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,QAAQ,IAAI,CAAC,IAAI,uCAAuC,UAAU,UAAU;iBACtF,CAAC;YACN,CAAC;YAGD,MAAM,YAAY,GAAG,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAG/D,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;YAEzD,IAAI,CAAC,WAAW,EAAE,CAAC;gBACf,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,GAAG,UAAU,YAAY,EAAE,YAAY;iBACjD,CAAC;YACN,CAAC;YAGD,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAEnD,IAAI,CAAC,aAAa,EAAE,CAAC;gBACjB,MAAM,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;gBACzC,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,YAAY,EAAE,OAAO,IAAI,yBAAyB;oBACzD,OAAO,EAAE,YAAY;iBACxB,CAAC;YACN,CAAC;YAED,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;QAC7B,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YAClB,QAAQ,CAAC,KAAK,CAAC,CAAC;YAChB,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,IAAI,eAAe,EAAE,CAAC;QACxE,CAAC;IACL,CAAC;IAKO,MAAM,CAAC,wBAAwB,CAAC,MAAkB,EAAE,EAAmB;QAC3E,IAAI,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAE7C,MAAM,eAAe,GAAG,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YAC9D,MAAM,YAAY,GAAG,IAAI,YAAY,EAAE,CAAC;YACxC,MAAM,KAAK,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;YAG5B,YAAY,CAAC,aAAa,GAAG;gBACzB,EAAE,SAAS,EAAE,eAAe,EAAE,KAAK,EAAE,KAAK,EAAE;aAC/C,CAAC;YAEF,OAAO,YAAY,CAAC;QACxB,CAAC;aAAM,CAAC;YAIJ,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAC;QAClG,CAAC;IACL,CAAC;CACJ"}
+{"version":3,"file":"EntityCRUDHandler.js","sourceRoot":"","sources":["../../src/rest/EntityCRUDHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EACS,YAAY,EAAuB,oBAAoB,EACnE,iBAAiB,EAAE,QAAQ,EAAE,QAAQ,EACxC,MAAM,sBAAsB,CAAC;AAE9B;;;GAGG;AACH,MAAM,OAAO,iBAAiB;IAC1B;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,UAAkB,EAAE,IAAS,EAAE,IAAc;QACnE,IAAI,CAAC;YACD,oBAAoB;YACpB,MAAM,EAAE,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC1B,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,eAAe,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YAE1D,oBAAoB;YACpB,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC;gBAC/D,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,QAAQ,IAAI,CAAC,IAAI,uCAAuC,UAAU,UAAU;iBACtF,CAAC;YACN,CAAC;YAED,oBAAoB;YACpB,MAAM,CAAC,SAAS,EAAE,CAAC;YAEnB,mCAAmC;YACnC,MAAM,OAAO,GAAG,IAAI,iBAAiB,EAAE,CAAC;YACxC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACf,MAAM,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,UAAU,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;gBAClH,IAAI,gBAAgB,KAAK,SAAS;oBAAE,OAAO,CAAC,gBAAgB,GAAG,CAAC,CAAC,gBAAgB,CAAC;gBAClF,IAAI,mBAAmB,KAAK,SAAS;oBAAE,OAAO,CAAC,mBAAmB,GAAG,CAAC,CAAC,mBAAmB,CAAC;gBAC3F,IAAI,iBAAiB,KAAK,SAAS;oBAAE,OAAO,CAAC,iBAAiB,GAAG,CAAC,CAAC,iBAAiB,CAAC;gBACrF,IAAI,UAAU,KAAK,SAAS;oBAAE,OAAO,CAAC,UAAU,GAAG,CAAC,CAAC,UAAU,CAAC;gBAChE,IAAI,kBAAkB,KAAK,SAAS;oBAAE,OAAO,CAAC,kBAAkB,GAAG,CAAC,CAAC,kBAAkB,CAAC;gBAExF,2BAA2B;gBAC3B,OAAO,IAAI,CAAC,OAAO,CAAC;YACxB,CAAC;YAED,2BAA2B;YAC3B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACrB,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YAC/B,CAAC;YAED,kBAAkB;YAClB,MAAM,gBAAgB,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC3C,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC;gBAC5B,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,mBAAmB;oBAC1B,gBAAgB,EAAE,gBAAgB,CAAC,MAAM;iBAC5C,CAAC;YACN,CAAC;YAED,cAAc;YACd,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAE/C,IAAI,CAAC,WAAW,EAAE,CAAC;gBACf,MAAM,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;gBACzC,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,YAAY,EAAE,OAAO,IAAI,yBAAyB;oBACzD,OAAO,EAAE,YAAY;iBACxB,CAAC;YACN,CAAC;YAED,+BAA+B;YAC/B,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,aAAa,EAAE,CAAC;YAChD,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;QACjD,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YAClB,QAAQ,CAAC,KAAK,CAAC,CAAC;YAChB,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,IAAI,eAAe,EAAE,CAAC;QACxE,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,UAAkB,EAAE,EAAmB,EAAE,kBAA4B,IAAI,EAAE,IAAc;QAC5G,IAAI,CAAC;YACD,oBAAoB;YACpB,MAAM,EAAE,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC1B,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,eAAe,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YAE1D,oBAAoB;YACpB,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC;gBAC7D,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,QAAQ,IAAI,CAAC,IAAI,qCAAqC,UAAU,UAAU;iBACpF,CAAC;YACN,CAAC;YAED,uBAAuB;YACvB,MAAM,YAAY,GAAG,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAE/D,cAAc;YACd,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;YAE1E,IAAI,CAAC,WAAW,EAAE,CAAC;gBACf,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,GAAG,UAAU,YAAY,EAAE,YAAY;iBACjD,CAAC;YACN,CAAC;YAED,+BAA+B;YAC/B,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,aAAa,EAAE,CAAC;YAChD,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;QACjD,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YAClB,QAAQ,CAAC,KAAK,CAAC,CAAC;YAChB,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,IAAI,eAAe,EAAE,CAAC;QACxE,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,UAAkB,EAAE,EAAmB,EAAE,IAAS,EAAE,IAAc;QACxF,IAAI,CAAC;YACD,oBAAoB;YACpB,MAAM,EAAE,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC1B,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,eAAe,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YAE1D,oBAAoB;YACpB,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC;gBAC/D,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,QAAQ,IAAI,CAAC,IAAI,uCAAuC,UAAU,UAAU;iBACtF,CAAC;YACN,CAAC;YAED,uBAAuB;YACvB,MAAM,YAAY,GAAG,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAE/D,cAAc;YACd,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;YAEzD,IAAI,CAAC,WAAW,EAAE,CAAC;gBACf,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,GAAG,UAAU,YAAY,EAAE,YAAY;iBACjD,CAAC;YACN,CAAC;YAED,mCAAmC;YACnC,MAAM,OAAO,GAAG,IAAI,iBAAiB,EAAE,CAAC;YACxC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBACf,MAAM,EAAE,gBAAgB,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,UAAU,EAAE,kBAAkB,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;gBAClH,IAAI,gBAAgB,KAAK,SAAS;oBAAE,OAAO,CAAC,gBAAgB,GAAG,CAAC,CAAC,gBAAgB,CAAC;gBAClF,IAAI,mBAAmB,KAAK,SAAS;oBAAE,OAAO,CAAC,mBAAmB,GAAG,CAAC,CAAC,mBAAmB,CAAC;gBAC3F,IAAI,iBAAiB,KAAK,SAAS;oBAAE,OAAO,CAAC,iBAAiB,GAAG,CAAC,CAAC,iBAAiB,CAAC;gBACrF,IAAI,UAAU,KAAK,SAAS;oBAAE,OAAO,CAAC,UAAU,GAAG,CAAC,CAAC,UAAU,CAAC;gBAChE,IAAI,kBAAkB,KAAK,SAAS;oBAAE,OAAO,CAAC,kBAAkB,GAAG,CAAC,CAAC,kBAAkB,CAAC;gBAExF,2BAA2B;gBAC3B,OAAO,IAAI,CAAC,OAAO,CAAC;YACxB,CAAC;YAED,gCAAgC;YAChC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACrB,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YAC/B,CAAC;YAED,2BAA2B;YAC3B,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;gBAC7C,kCAAkC;gBAClC,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,aAAa,EAAE,CAAC;gBAChD,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;YACjD,CAAC;YAED,kBAAkB;YAClB,MAAM,gBAAgB,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC3C,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC;gBAC5B,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,mBAAmB;oBAC1B,gBAAgB,EAAE,gBAAgB,CAAC,MAAM;iBAC5C,CAAC;YACN,CAAC;YAED,cAAc;YACd,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YAE/C,IAAI,CAAC,WAAW,EAAE,CAAC;gBACf,MAAM,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;gBACzC,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,YAAY,EAAE,OAAO,IAAI,yBAAyB;oBACzD,OAAO,EAAE,YAAY;iBACxB,CAAC;YACN,CAAC;YAED,+BAA+B;YAC/B,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,aAAa,EAAE,CAAC;YAChD,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC;QACjD,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YAClB,QAAQ,CAAC,KAAK,CAAC,CAAC;YAChB,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,IAAI,eAAe,EAAE,CAAC;QACxE,CAAC;IACL,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,UAAkB,EAAE,EAAmB,EAAE,OAA4B,EAAE,IAAc;QAC3G,IAAI,CAAC;YACD,oBAAoB;YACpB,MAAM,EAAE,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC1B,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,eAAe,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;YAE1D,oBAAoB;YACpB,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC;gBAC/D,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,QAAQ,IAAI,CAAC,IAAI,uCAAuC,UAAU,UAAU;iBACtF,CAAC;YACN,CAAC;YAED,uBAAuB;YACvB,MAAM,YAAY,GAAG,IAAI,CAAC,wBAAwB,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAE/D,cAAc;YACd,MAAM,WAAW,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;YAEzD,IAAI,CAAC,WAAW,EAAE,CAAC;gBACf,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,GAAG,UAAU,YAAY,EAAE,YAAY;iBACjD,CAAC;YACN,CAAC;YAED,oBAAoB;YACpB,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAEnD,IAAI,CAAC,aAAa,EAAE,CAAC;gBACjB,MAAM,YAAY,GAAG,MAAM,CAAC,YAAY,CAAC;gBACzC,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,YAAY,EAAE,OAAO,IAAI,yBAAyB;oBACzD,OAAO,EAAE,YAAY;iBACxB,CAAC;YACN,CAAC;YAED,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;QAC7B,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YAClB,QAAQ,CAAC,KAAK,CAAC,CAAC;YAChB,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,IAAI,eAAe,EAAE,CAAC;QACxE,CAAC;IACL,CAAC;IAED;;OAEG;IACK,MAAM,CAAC,wBAAwB,CAAC,MAAkB,EAAE,EAAmB;QAC3E,IAAI,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7C,qBAAqB;YACrB,MAAM,eAAe,GAAG,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;YAC9D,MAAM,YAAY,GAAG,IAAI,YAAY,EAAE,CAAC;YACxC,MAAM,KAAK,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;YAE5B,0CAA0C;YAC1C,YAAY,CAAC,aAAa,GAAG;gBACzB,EAAE,SAAS,EAAE,eAAe,EAAE,KAAK,EAAE,KAAK,EAAE;aAC/C,CAAC;YAEF,OAAO,YAAY,CAAC;QACxB,CAAC;aAAM,CAAC;YACJ,mDAAmD;YACnD,0EAA0E;YAC1E,kDAAkD;YAClD,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAC;QAClG,CAAC;IACL,CAAC;CACJ"}

package/dist/rest/OAuthCallbackHandler.d.ts

@@ -0,0 +1,143 @@
+/**
+ * @fileoverview OAuth Callback Handler for MCP OAuth flows
+ *
+ * Handles OAuth authorization callbacks from external authorization servers.
+ * This endpoint is unauthenticated since it's called by the auth server after user consent.
+ *
+ * Endpoints:
+ * - GET /api/v1/oauth/callback - Authorization callback
+ * - GET /api/v1/oauth/status/:stateParameter - Poll for authorization status (authenticated)
+ * - POST /api/v1/oauth/initiate - Initiate OAuth flow (authenticated)
+ *
+ * @module @memberjunction/server/rest/OAuthCallbackHandler
+ */
+import express from 'express';
+/**
+ * Configuration for OAuth callback handler
+ */
+export interface OAuthCallbackHandlerOptions {
+    /** Base URL for this MJAPI instance (for redirects) */
+    publicUrl: string;
+    /** URL to redirect to after successful authorization */
+    successRedirectUrl?: string;
+    /** URL to redirect to after failed authorization */
+    errorRedirectUrl?: string;
+}
+/**
+ * Handles OAuth callbacks and related endpoints for MCP server authentication.
+ *
+ * The callback endpoint is unauthenticated because it's called by external auth servers.
+ * It uses the state parameter to look up the authorization context and validate the flow.
+ *
+ * @example
+ * ```typescript
+ * const oauthHandler = new OAuthCallbackHandler({
+ *     publicUrl: 'https://api.example.com'
+ * });
+ *
+ * // Mount unauthenticated callback route
+ * app.use('/api/v1/oauth', oauthHandler.getCallbackRouter());
+ *
+ * // Mount authenticated routes
+ * app.use('/api/v1/oauth', authMiddleware, oauthHandler.getAuthenticatedRouter());
+ * ```
+ */
+export declare class OAuthCallbackHandler {
+    private readonly options;
+    private readonly oauthManager;
+    private readonly callbackRouter;
+    private readonly authenticatedRouter;
+    constructor(options: OAuthCallbackHandlerOptions);
+    /**
+     * Sets up all routes for OAuth handling.
+     */
+    private setupRoutes;
+    /**
+     * Renders a success page after OAuth authorization completes.
+     */
+    private handleSuccessPage;
+    /**
+     * Renders an error page when OAuth authorization fails.
+     */
+    private handleErrorPage;
+    /**
+     * Handles the OAuth authorization callback.
+     *
+     * This endpoint is unauthenticated - the auth server redirects here after user consent.
+     * We validate the state parameter and exchange the code for tokens.
+     *
+     * @param req - Express request
+     * @param res - Express response
+     */
+    private handleCallback;
+    /**
+     * Gets the status of an OAuth authorization flow.
+     *
+     * Authenticated endpoint for polling authorization status.
+     *
+     * @param req - Express request
+     * @param res - Express response
+     */
+    private getStatus;
+    /**
+     * Initiates a new OAuth authorization flow.
+     *
+     * Authenticated endpoint for starting OAuth authorization.
+     *
+     * @param req - Express request
+     * @param res - Express response
+     */
+    private initiateFlow;
+    /**
+     * Exchanges an authorization code for tokens.
+     *
+     * This endpoint is used when the frontend handles the OAuth callback.
+     * The frontend receives the code and state from the OAuth provider redirect,
+     * then calls this authenticated endpoint to complete the token exchange.
+     *
+     * @param req - Express request with { code, state } in body
+     * @param res - Express response
+     */
+    private handleExchange;
+    /**
+     * Gets the system user from cache.
+     */
+    private getSystemUser;
+    /**
+     * Loads authorization state from database.
+     */
+    private loadAuthorizationState;
+    /**
+     * Loads connection and server OAuth configuration.
+     */
+    private loadConnectionConfig;
+    /**
+     * Redirects to success page with state info.
+     * If a frontend return URL is provided, redirects there instead of the default success page.
+     */
+    private redirectToSuccess;
+    /**
+     * Redirects to error page with error info.
+     * If a frontend return URL is provided, redirects there instead of the default error page.
+     */
+    private redirectToError;
+    /**
+     * Gets the router for unauthenticated callback endpoint.
+     */
+    getCallbackRouter(): express.Router;
+    /**
+     * Gets the router for authenticated OAuth endpoints.
+     */
+    getAuthenticatedRouter(): express.Router;
+}
+/**
+ * Creates and configures the OAuth callback handler.
+ *
+ * @param options - Handler configuration
+ * @returns Object with callback and authenticated routers
+ */
+export declare function createOAuthCallbackHandler(options: OAuthCallbackHandlerOptions): {
+    callbackRouter: express.Router;
+    authenticatedRouter: express.Router;
+};
+//# sourceMappingURL=OAuthCallbackHandler.d.ts.map

package/dist/rest/OAuthCallbackHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"OAuthCallbackHandler.d.ts","sourceRoot":"","sources":["../../src/rest/OAuthCallbackHandler.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,OAAO,MAAM,SAAS,CAAC;AAe9B;;GAEG;AACH,MAAM,WAAW,2BAA2B;IACxC,uDAAuD;IACvD,SAAS,EAAE,MAAM,CAAC;IAClB,wDAAwD;IACxD,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,oDAAoD;IACpD,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,oBAAoB;IAC7B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA8B;IACtD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAe;IAC5C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAiB;IAChD,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAiB;gBAEzC,OAAO,EAAE,2BAA2B;IAYhD;;OAEG;IACH,OAAO,CAAC,WAAW;IAcnB;;OAEG;IACH,OAAO,CAAC,iBAAiB;IA8BzB;;OAEG;IACH,OAAO,CAAC,eAAe;IAmCvB;;;;;;;;OAQG;YACW,cAAc;IAkF5B;;;;;;;OAOG;YACW,SAAS;IA0EvB;;;;;;;OAOG;YACW,YAAY;IA2F1B;;;;;;;;;OASG;YACW,cAAc;IA+F5B;;OAEG;IACH,OAAO,CAAC,aAAa;IAQrB;;OAEG;YACW,sBAAsB;IAoDpC;;OAEG;YACW,oBAAoB;IAmElC;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAwBzB;;;OAGG;IACH,OAAO,CAAC,eAAe;IAwBvB;;OAEG;IACI,iBAAiB,IAAI,OAAO,CAAC,MAAM;IAI1C;;OAEG;IACI,sBAAsB,IAAI,OAAO,CAAC,MAAM;CAGlD;AAED;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,2BAA2B,GAAG;IAC9E,cAAc,EAAE,OAAO,CAAC,MAAM,CAAC;IAC/B,mBAAmB,EAAE,OAAO,CAAC,MAAM,CAAC;CACvC,CAMA"}