@memberjunction/ai-recommendations 2.4.0 → 2.5.0

package/dist/Engine.d.ts

@@ -1,37 +1,18 @@
 import { BaseEngine, UserInfo } from '@memberjunction/core';
-import { RecommendationEntity, RecommendationProviderEntity, RecommendationRunEntity } from '@memberjunction/core-entities';
-/**
- * Used to make requests to providers
- */
-export declare class RecommendationRequest {
-    /**
-     * Array of the requested recommendations
-     */
-    Recommendations: RecommendationEntity[];
-    /**
-     * The specific provider to use for the request. Leave this undefined if you want to use the default recommendation.
-     */
-    Provider?: RecommendationProviderEntity;
-}
-/**
- * This response is generated for each Recommend() request
- */
-export declare class RecommendationResult {
-    Success: boolean;
-    Request: RecommendationRequest;
-    ErrorMessage: string;
-    constructor(request: RecommendationRequest);
-}
+import { RecommendationProviderEntity } from '@memberjunction/core-entities';
+import { RecommendationRequest, RecommendationResult } from './generic/types';
 /**
  * Engine class to be used for running all recommendation requests
  */
 export declare class RecommendationEngineBase extends BaseEngine<RecommendationEngineBase> {
     private _RecommendationProviders;
+    static get Instance(): RecommendationEngineBase;
+    get RecommendationProviders(): RecommendationProviderEntity[];
     Config(forceRefresh?: boolean, contextUser?: UserInfo): Promise<void>;
-    /**
-     * Call this method with a provider and a request and a result will be generated
-     * @param request - The Recommendations to request, and an optional provider
-     */
-    Recommend(request: RecommendationRequest): Promise<RecommendationRunEntity>;
+    Recommend(request: RecommendationRequest): Promise<RecommendationResult>;
+    private GetRecommendationEntities;
+    private GetRecommendationsByListID;
+    private GetRecommendationsByRecordIDs;
+    private IsNullOrUndefined;
 }
 //# sourceMappingURL=Engine.d.ts.map

package/dist/Engine.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Engine.d.ts","sourceRoot":"","sources":["../src/Engine.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAY,QAAQ,EAAY,MAAM,sBAAsB,CAAC;AAChF,OAAO,EAAE,oBAAoB,EAAE,4BAA4B,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AAI5H;;GAEG;AACH,qBAAa,qBAAqB;IAChC;;OAEG;IACH,eAAe,EAAE,oBAAoB,EAAE,CAAM;IAE7C;;OAEG;IACH,QAAQ,CAAC,EAAE,4BAA4B,CAAC;CACzC;AAED;;GAEG;AACH,qBAAa,oBAAoB;IAC/B,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,EAAE,qBAAqB,CAAC;IAC/B,YAAY,EAAE,MAAM,CAAC;gBAET,OAAO,EAAE,qBAAqB;CAG3C;AAED;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,UAAU,CAAC,wBAAwB,CAAC;IAChF,OAAO,CAAC,wBAAwB,CAAsC;IAEzD,MAAM,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,QAAQ;IAUlE;;;OAGG;IACU,SAAS,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,uBAAuB,CAAC;CAiDzF"}
+{"version":3,"file":"Engine.d.ts","sourceRoot":"","sources":["../src/Engine.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAY,QAAQ,EAAkC,MAAM,sBAAsB,CAAC;AACtG,OAAO,EAA8D,4BAA4B,EAA2B,MAAM,+BAA+B,CAAC;AAGlK,OAAO,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAE9E;;GAEG;AACH,qBAAa,wBAAyB,SAAQ,UAAU,CAAC,wBAAwB,CAAC;IAChF,OAAO,CAAC,wBAAwB,CAAsC;IAEtE,WAAkB,QAAQ,IAAI,wBAAwB,CAErD;IAED,IAAW,uBAAuB,IAAI,4BAA4B,EAAE,CAEnE;IAEY,MAAM,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,QAAQ;IAWrD,SAAS,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,oBAAoB,CAAC;YAwDvE,yBAAyB;YA4BzB,0BAA0B;YAoE1B,6BAA6B;IAiC3C,OAAO,CAAC,iBAAiB;CAG1B"}

package/dist/Engine.js

@@ -1,30 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RecommendationEngineBase = exports.RecommendationResult = exports.RecommendationRequest = void 0;
+exports.RecommendationEngineBase = void 0;
 const core_1 = require("@memberjunction/core");
 const global_1 = require("@memberjunction/global");
 const ProviderBase_1 = require("./ProviderBase");
-/**
- * Used to make requests to providers
- */
-class RecommendationRequest {
-    constructor() {
-        /**
-         * Array of the requested recommendations
-         */
-        this.Recommendations = [];
-    }
-}
-exports.RecommendationRequest = RecommendationRequest;
-/**
- * This response is generated for each Recommend() request
- */
-class RecommendationResult {
-    constructor(request) {
-        this.Request = request;
-    }
-}
-exports.RecommendationResult = RecommendationResult;
 /**
  * Engine class to be used for running all recommendation requests
  */
@@ -33,6 +12,12 @@ class RecommendationEngineBase extends core_1.BaseEngine {
         super(...arguments);
         this._RecommendationProviders = [];
     }
+    static get Instance() {
+        return super.getInstance();
+    }
+    get RecommendationProviders() {
+        return this._RecommendationProviders;
+    }
     async Config(forceRefresh, contextUser) {
         const params = [
             {
@@ -42,51 +27,158 @@ class RecommendationEngineBase extends core_1.BaseEngine {
         ];
         return await this.Load(params, forceRefresh, contextUser);
     }
-    /**
-     * Call this method with a provider and a request and a result will be generated
-     * @param request - The Recommendations to request, and an optional provider
-     */
     async Recommend(request) {
-        const provider = request.Provider ?? this._RecommendationProviders[0];
+        super.TryThrowIfNotLoaded();
+        let provider = request.Provider;
         if (!provider) {
-            throw new Error('No recommendation provider available');
+            if (this.RecommendationProviders.length == 0) {
+                throw new Error('No recommendation provider provider and no provider found in metadata');
+            }
+            else {
+                provider = this.RecommendationProviders[0];
+            }
         }
+        (0, core_1.LogStatus)(`Recommendation Engine is using provider: ${provider.Name}`);
         // get the driver
         const driver = global_1.MJGlobal.Instance.ClassFactory.CreateInstance(ProviderBase_1.RecommendationProviderBase, provider.Name);
-        // make sure we have only one run
-        const runIDs = [...new Set(request.Recommendations.map((r) => r.RecommendationRunID))];
-        if (runIDs.length > 1) {
-            const message = 'All Recommendations must use the same RecommendationRunID';
-            (0, core_1.LogError)(message, null, { runIDs });
-            throw new Error(message);
-        }
-        const [runID] = runIDs;
-        // load the run
-        const run = await new core_1.Metadata().GetEntityObject('Recommendation Runs');
-        if (!(await run.Load(runID))) {
-            throw new Error(`Error loading RecommendationRun with ID: ${runID}`);
+        if (!driver) {
+            throw new Error(`Could not find driver for provider: ${provider.Name}`);
         }
+        const recommendations = await this.GetRecommendationEntities(request);
+        (0, core_1.LogStatus)(`Processing ${recommendations.length} recommendations`);
+        request.Recommendations = recommendations;
+        // load the run
+        const recommendationRunEntity = await new core_1.Metadata().GetEntityObject('Recommendation Runs', request.CurrentUser);
+        recommendationRunEntity.NewRecord();
         // update status for current run
-        run.Status = 'In Progress';
-        if (!(await run.Save())) {
-            throw new Error(`Error saving In Progress RecommendationRun with ID: ${runID}`);
-        }
-        const result = await driver.Recommend(request);
-        // finalize status for current run
-        if (result.Success) {
-            run.Status = 'Completed';
-            if (!(await run.Save())) {
-                throw new Error(`Error saving Completed RecommendationRun with ID: ${runID}`);
+        recommendationRunEntity.Status = 'In Progress';
+        recommendationRunEntity.RecommendationProviderID = provider.ID;
+        recommendationRunEntity.StartDate = new Date();
+        recommendationRunEntity.RunByUserID = request.CurrentUser ? request.CurrentUser.ID : super.ContextUser.ID;
+        const saveResult = await recommendationRunEntity.Save();
+        if (!saveResult) {
+            (0, core_1.LogStatus)(`Error saving RecommendationRun entity: `, undefined, recommendationRunEntity.LatestResult);
+            throw new Error('Error creating Recommendation Run entity');
+        }
+        request.RunID = recommendationRunEntity.ID;
+        const recommendResult = await driver.Recommend(request);
+        recommendationRunEntity.Status = recommendResult.Success ? 'Completed' : 'Error';
+        recommendationRunEntity.Description = recommendResult.ErrorMessage;
+        const postRunSaveResult = await recommendationRunEntity.Save();
+        if (!postRunSaveResult) {
+            (0, core_1.LogStatus)(`Error saving RecommendationRun entity: `, undefined, recommendationRunEntity.LatestResult);
+            throw new Error('Error updating Recommendation Run entity');
+        }
+        return recommendResult;
+    }
+    async GetRecommendationEntities(request) {
+        if (request.Recommendations) {
+            const invalidEntities = request.Recommendations.filter((r) => !this.IsNullOrUndefined(r.RecommendationRunID) || r.IsSaved);
+            if (invalidEntities.length > 0) {
+                throw new Error(`Recommendation entities must be new, not saved and have their RecommendationRunID not set. Invalid entities: ${invalidEntities.map((r) => r.ID).join(',')}`);
             }
+            return request.Recommendations;
         }
-        else {
-            run.Status = 'Error';
-            run.Description = result.ErrorMessage;
-            if (!(await run.Save())) {
-                throw new Error(`Error saving Errored RecommendationRun with ID: ${runID}`);
+        else if (request.ListID) {
+            return await this.GetRecommendationsByListID(request.ListID, request.CurrentUser);
+        }
+        else if (request.EntityAndRecordsInfo) {
+            const entityName = request.EntityAndRecordsInfo.EntityName;
+            const recordIDs = request.EntityAndRecordsInfo.RecordIDs;
+            if (!entityName) {
+                throw new Error('Entity name is required in EntityAndRecordsInfo');
+            }
+            if (!recordIDs) {
+                throw new Error('RecordIDs are required in EntityAndRecordsInfo');
             }
+            return await this.GetRecommendationsByRecordIDs(entityName, recordIDs, request.CurrentUser);
+        }
+    }
+    async GetRecommendationsByListID(listID, currentUser) {
+        const rv = new core_1.RunView();
+        const md = new core_1.Metadata();
+        const rvListDetailsResult = await rv.RunViews([
+            {
+                EntityName: 'Lists',
+                ExtraFilter: `ID = '${listID}'`,
+                ResultType: 'simple'
+            },
+            {
+                EntityName: 'List Details',
+                ExtraFilter: `ListID = '${listID}'`,
+                ResultType: 'simple',
+                IgnoreMaxRows: true,
+            }
+        ], currentUser);
+        const listViewResult = rvListDetailsResult[0];
+        if (!listViewResult.Success) {
+            throw new Error(`Error getting list with ID: ${listID}: ${listViewResult.ErrorMessage}`);
+        }
+        if (listViewResult.Results.length == 0) {
+            throw new Error(`No list found with ID: ${listID}`);
         }
-        return run;
+        const list = listViewResult.Results[0];
+        const entityName = list.Entity;
+        (0, core_1.LogStatus)(`Getting recommendations for list: ${list.Name}. Entity: ${entityName}`);
+        const entityID = list.EntityID;
+        const entity = md.Entities.find((e) => e.ID == entityID);
+        const needsQuotes = entity.FirstPrimaryKey.NeedsQuotes ? "'" : '';
+        const listDetailsResult = rvListDetailsResult[1];
+        if (!listDetailsResult.Success) {
+            throw new Error(`Error getting list details for listID: ${listID}: ${listDetailsResult.ErrorMessage}`);
+        }
+        //list is empty, just exit early
+        if (listDetailsResult.Results.length == 0) {
+            return [];
+        }
+        const recordIDs = listDetailsResult.Results.map((ld) => `${needsQuotes}${ld.RecordID}${needsQuotes}`).join(',');
+        const rvEntityResult = await rv.RunView({
+            EntityName: entityName,
+            ExtraFilter: `${entity.FirstPrimaryKey.Name} IN (${recordIDs})`,
+            IgnoreMaxRows: true,
+        }, currentUser);
+        if (!rvEntityResult.Success) {
+            throw new Error(`Error getting entity records for listID: ${listID}: ${rvEntityResult.ErrorMessage}`);
+        }
+        let recommendations = [];
+        for (const entity of rvEntityResult.Results) {
+            const recommendationEntity = await md.GetEntityObject('Recommendations', currentUser);
+            recommendationEntity.NewRecord();
+            recommendationEntity.SourceEntityID = entityID;
+            recommendationEntity.SourceEntityRecordID = entity.ID;
+            recommendations.push(recommendationEntity);
+        }
+        return recommendations;
+    }
+    async GetRecommendationsByRecordIDs(entityName, recordIDs, currentUser) {
+        const md = new core_1.Metadata();
+        const rv = new core_1.RunView();
+        const entity = md.Entities.find((e) => e.Name.toLowerCase() == entityName.toLowerCase());
+        if (!entity) {
+            throw new Error(`Unable to get recommendations by entity info: Entity not found with name: ${entityName}`);
+        }
+        (0, core_1.LogStatus)(`Getting recommendations for entity: ${entityName}`);
+        const needsQuotes = entity.FirstPrimaryKey.NeedsQuotes ? "'" : '';
+        const recordIDsFilter = recordIDs.map((id) => `${needsQuotes}${id}${needsQuotes}`).join(',');
+        const rvEntityResult = await rv.RunView({
+            EntityName: entityName,
+            ExtraFilter: `${entity.FirstPrimaryKey.Name} IN (${recordIDsFilter})`,
+            IgnoreMaxRows: true,
+        }, currentUser);
+        if (!rvEntityResult.Success) {
+            throw new Error(`Error getting entity records for entity: ${entityName}: ${rvEntityResult.ErrorMessage}`);
+        }
+        let recommendations = [];
+        for (const entity of rvEntityResult.Results) {
+            const recommendationEntity = await md.GetEntityObject('Recommendations', currentUser);
+            recommendationEntity.NewRecord();
+            recommendationEntity.SourceEntityID = entity.ID;
+            recommendations.push(recommendationEntity);
+        }
+        return recommendations;
+    }
+    IsNullOrUndefined(value) {
+        return value === null || value === undefined;
     }
 }
 exports.RecommendationEngineBase = RecommendationEngineBase;

package/dist/Engine.js.map

@@ -1 +1 @@
-{"version":3,"file":"Engine.js","sourceRoot":"","sources":["../src/Engine.ts"],"names":[],"mappings":";;;AAAA,+CAAgF;AAEhF,mDAAkD;AAClD,iDAA4D;AAE5D;;GAEG;AACH,MAAa,qBAAqB;IAAlC;QACE;;WAEG;QACH,oBAAe,GAA2B,EAAE,CAAC;IAM/C,CAAC;CAAA;AAVD,sDAUC;AAED;;GAEG;AACH,MAAa,oBAAoB;IAK/B,YAAY,OAA8B;QACxC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AARD,oDAQC;AAED;;GAEG;AACH,MAAa,wBAAyB,SAAQ,iBAAoC;IAAlF;;QACU,6BAAwB,GAAmC,EAAE,CAAC;IAiExE,CAAC;IA/DQ,KAAK,CAAC,MAAM,CAAC,YAAsB,EAAE,WAAsB;QAChE,MAAM,MAAM,GAAG;YACb;gBACE,YAAY,EAAE,0BAA0B;gBACxC,UAAU,EAAE,0BAA0B;aACvC;SACF,CAAC;QACF,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,SAAS,CAAC,OAA8B;QACnD,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC;QAEtE,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;QAC1D,CAAC;QAED,iBAAiB;QACjB,MAAM,MAAM,GAAG,iBAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,cAAc,CAA6B,yCAA0B,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;QAEpI,iCAAiC;QACjC,MAAM,MAAM,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;QACvF,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACtB,MAAM,OAAO,GAAG,2DAA2D,CAAC;YAC5E,IAAA,eAAQ,EAAC,OAAO,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;YACpC,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;QAC3B,CAAC;QACD,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC;QAEvB,eAAe;QACf,MAAM,GAAG,GAAG,MAAM,IAAI,eAAQ,EAAE,CAAC,eAAe,CAA0B,qBAAqB,CAAC,CAAC;QACjG,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,4CAA4C,KAAK,EAAE,CAAC,CAAC;QACvE,CAAC;QAED,gCAAgC;QAChC,GAAG,CAAC,MAAM,GAAG,aAAa,CAAC;QAC3B,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CAAC,uDAAuD,KAAK,EAAE,CAAC,CAAC;QAClF,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAE/C,kCAAkC;QAClC,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACnB,GAAG,CAAC,MAAM,GAAG,WAAW,CAAC;YACzB,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;gBACxB,MAAM,IAAI,KAAK,CAAC,qDAAqD,KAAK,EAAE,CAAC,CAAC;YAChF,CAAC;QACH,CAAC;aAAM,CAAC;YACN,GAAG,CAAC,MAAM,GAAG,OAAO,CAAC;YACrB,GAAG,CAAC,WAAW,GAAG,MAAM,CAAC,YAAY,CAAC;YACtC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;gBACxB,MAAM,IAAI,KAAK,CAAC,mDAAmD,KAAK,EAAE,CAAC,CAAC;YAC9E,CAAC;QACH,CAAC;QAED,OAAO,GAAG,CAAC;IACb,CAAC;CACF;AAlED,4DAkEC"}
+{"version":3,"file":"Engine.js","sourceRoot":"","sources":["../src/Engine.ts"],"names":[],"mappings":";;;AAAA,+CAAsG;AAEtG,mDAAkD;AAClD,iDAA4D;AAG5D;;GAEG;AACH,MAAa,wBAAyB,SAAQ,iBAAoC;IAAlF;;QACU,6BAAwB,GAAmC,EAAE,CAAC;IAiNxE,CAAC;IA/MQ,MAAM,KAAK,QAAQ;QACxB,OAAO,KAAK,CAAC,WAAW,EAA4B,CAAC;IACvD,CAAC;IAED,IAAW,uBAAuB;QAChC,OAAO,IAAI,CAAC,wBAAwB,CAAC;IACvC,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,YAAsB,EAAE,WAAsB;QAChE,MAAM,MAAM,GAAG;YACb;gBACE,YAAY,EAAE,0BAA0B;gBACxC,UAAU,EAAE,0BAA0B;aACvC;SACF,CAAC;QAEF,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;IAC5D,CAAC;IAEM,KAAK,CAAC,SAAS,CAAC,OAA8B;QACnD,KAAK,CAAC,mBAAmB,EAAE,CAAC;QAE5B,IAAI,QAAQ,GAAiC,OAAO,CAAC,QAAQ,CAAC;QAC9D,IAAI,CAAC,QAAQ,EAAC,CAAC;YACb,IAAG,IAAI,CAAC,uBAAuB,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;gBAC5C,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;YAC3F,CAAC;iBACG,CAAC;gBACH,QAAQ,GAAG,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC;YAC7C,CAAC;QACH,CAAC;QAED,IAAA,gBAAS,EAAC,4CAA4C,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;QAEvE,iBAAiB;QACjB,MAAM,MAAM,GAAG,iBAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,cAAc,CAA6B,yCAA0B,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;QAEpI,IAAG,CAAC,MAAM,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,uCAAuC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;QAC1E,CAAC;QAED,MAAM,eAAe,GAA2B,MAAM,IAAI,CAAC,yBAAyB,CAAC,OAAO,CAAC,CAAC;QAC9F,IAAA,gBAAS,EAAC,cAAc,eAAe,CAAC,MAAM,kBAAkB,CAAC,CAAC;QAClE,OAAO,CAAC,eAAe,GAAG,eAAe,CAAC;QAE1C,eAAe;QACf,MAAM,uBAAuB,GAAG,MAAM,IAAI,eAAQ,EAAE,CAAC,eAAe,CAA0B,qBAAqB,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;QAC1I,uBAAuB,CAAC,SAAS,EAAE,CAAC;QAEpC,gCAAgC;QAChC,uBAAuB,CAAC,MAAM,GAAG,aAAa,CAAC;QAC/C,uBAAuB,CAAC,wBAAwB,GAAG,QAAQ,CAAC,EAAE,CAAC;QAC/D,uBAAuB,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;QAC/C,uBAAuB,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC;QAE1G,MAAM,UAAU,GAAY,MAAM,uBAAuB,CAAC,IAAI,EAAE,CAAC;QACjE,IAAG,CAAC,UAAU,EAAE,CAAC;YACf,IAAA,gBAAS,EAAC,yCAAyC,EAAE,SAAS,EAAE,uBAAuB,CAAC,YAAY,CAAC,CAAC;YACtG,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAC9D,CAAC;QAED,OAAO,CAAC,KAAK,GAAG,uBAAuB,CAAC,EAAE,CAAC;QAC3C,MAAM,eAAe,GAAyB,MAAM,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAC9E,uBAAuB,CAAC,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC;QACjF,uBAAuB,CAAC,WAAW,GAAG,eAAe,CAAC,YAAY,CAAC;QAEnE,MAAM,iBAAiB,GAAY,MAAM,uBAAuB,CAAC,IAAI,EAAE,CAAC;QACxE,IAAG,CAAC,iBAAiB,EAAE,CAAC;YACtB,IAAA,gBAAS,EAAC,yCAAyC,EAAE,SAAS,EAAE,uBAAuB,CAAC,YAAY,CAAC,CAAC;YACtG,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAC9D,CAAC;QAED,OAAO,eAAe,CAAC;IACzB,CAAC;IAEO,KAAK,CAAC,yBAAyB,CAAC,OAA8B;QACpE,IAAG,OAAO,CAAC,eAAe,EAAC,CAAC;YAC1B,MAAM,eAAe,GAA2B,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC;YACnJ,IAAG,eAAe,CAAC,MAAM,GAAG,CAAC,EAAC,CAAC;gBAC7B,MAAM,IAAI,KAAK,CAAC,gHAAgH,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAChL,CAAC;YAED,OAAO,OAAO,CAAC,eAAe,CAAC;QACjC,CAAC;aACI,IAAG,OAAO,CAAC,MAAM,EAAC,CAAC;YACtB,OAAO,MAAM,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;QACpF,CAAC;aACI,IAAG,OAAO,CAAC,oBAAoB,EAAC,CAAC;YACpC,MAAM,UAAU,GAAG,OAAO,CAAC,oBAAoB,CAAC,UAAU,CAAC;YAC3D,MAAM,SAAS,GAAG,OAAO,CAAC,oBAAoB,CAAC,SAAS,CAAC;YAEzD,IAAG,CAAC,UAAU,EAAC,CAAC;gBACd,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;YACrE,CAAC;YAED,IAAG,CAAC,SAAS,EAAC,CAAC;gBACb,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;YACpE,CAAC;YAED,OAAO,MAAM,IAAI,CAAC,6BAA6B,CAAC,UAAU,EAAE,SAAS,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;QAC9F,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,0BAA0B,CAAC,MAAc,EAAE,WAAsB;QAC7E,MAAM,EAAE,GAAY,IAAI,cAAO,EAAE,CAAC;QAClC,MAAM,EAAE,GAAa,IAAI,eAAQ,EAAE,CAAC;QAEpC,MAAM,mBAAmB,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC;YAC5C;gBACE,UAAU,EAAE,OAAO;gBACnB,WAAW,EAAE,SAAS,MAAM,GAAG;gBAC/B,UAAU,EAAE,QAAQ;aACrB;YACD;gBACE,UAAU,EAAE,cAAc;gBAC1B,WAAW,EAAE,aAAa,MAAM,GAAG;gBACnC,UAAU,EAAE,QAAQ;gBACpB,aAAa,EAAE,IAAI;aACpB;SACF,EAAE,WAAW,CAAC,CAAC;QAEhB,MAAM,cAAc,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAC;QAC9C,IAAG,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,+BAA+B,MAAM,KAAK,cAAc,CAAC,YAAY,EAAE,CAAC,CAAC;QAC3F,CAAC;QAED,IAAG,cAAc,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,0BAA0B,MAAM,EAAE,CAAC,CAAC;QACtD,CAAC;QAED,MAAM,IAAI,GAAmB,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QACvD,MAAM,UAAU,GAAW,IAAI,CAAC,MAAM,CAAC;QACvC,IAAA,gBAAS,EAAC,qCAAqC,IAAI,CAAC,IAAI,aAAa,UAAU,EAAE,CAAC,CAAC;QAEnF,MAAM,QAAQ,GAAW,IAAI,CAAC,QAAQ,CAAC;QACvC,MAAM,MAAM,GAAe,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,QAAQ,CAAC,CAAC;QACrE,MAAM,WAAW,GAAW,MAAM,CAAC,eAAe,CAAC,WAAW,CAAA,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAEzE,MAAM,iBAAiB,GAAG,mBAAmB,CAAC,CAAC,CAAC,CAAC;QACjD,IAAG,CAAC,iBAAiB,CAAC,OAAO,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CAAC,0CAA0C,MAAM,KAAK,iBAAiB,CAAC,YAAY,EAAE,CAAC,CAAC;QACzG,CAAC;QAED,gCAAgC;QAChC,IAAG,iBAAiB,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YACzC,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,SAAS,GAAW,iBAAiB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,EAAwB,EAAE,EAAE,CAAC,GAAG,WAAW,GAAG,EAAE,CAAC,QAAQ,GAAG,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC9I,MAAM,cAAc,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC;YACtC,UAAU,EAAE,UAAU;YACtB,WAAW,EAAE,GAAG,MAAM,CAAC,eAAe,CAAC,IAAI,QAAQ,SAAS,GAAG;YAC/D,aAAa,EAAE,IAAI;SACpB,EAAE,WAAW,CAAC,CAAC;QAEhB,IAAG,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,4CAA4C,MAAM,KAAK,cAAc,CAAC,YAAY,EAAE,CAAC,CAAC;QACxG,CAAC;QAED,IAAI,eAAe,GAA2B,EAAE,CAAC;QACjD,KAAI,MAAM,MAAM,IAAI,cAAc,CAAC,OAAO,EAAE,CAAC;YAC3C,MAAM,oBAAoB,GAAyB,MAAM,EAAE,CAAC,eAAe,CAAuB,iBAAiB,EAAE,WAAW,CAAC,CAAC;YAClI,oBAAoB,CAAC,SAAS,EAAE,CAAC;YACjC,oBAAoB,CAAC,cAAc,GAAG,QAAQ,CAAC;YAC/C,oBAAoB,CAAC,oBAAoB,GAAG,MAAM,CAAC,EAAE,CAAC;YACtD,eAAe,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAC7C,CAAC;QAED,OAAO,eAAe,CAAC;IACzB,CAAC;IAEO,KAAK,CAAC,6BAA6B,CAAC,UAAkB,EAAE,SAAiC,EAAE,WAAsB;QACvH,MAAM,EAAE,GAAa,IAAI,eAAQ,EAAE,CAAC;QACpC,MAAM,EAAE,GAAY,IAAI,cAAO,EAAE,CAAC;QAElC,MAAM,MAAM,GAAe,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,UAAU,CAAC,WAAW,EAAE,CAAC,CAAC;QACrG,IAAG,CAAC,MAAM,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CAAC,6EAA6E,UAAU,EAAE,CAAC,CAAC;QAC7G,CAAC;QAED,IAAA,gBAAS,EAAC,uCAAuC,UAAU,EAAE,CAAC,CAAC;QAC/D,MAAM,WAAW,GAAW,MAAM,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1E,MAAM,eAAe,GAAW,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,WAAW,GAAG,EAAE,GAAG,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACrG,MAAM,cAAc,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC;YACtC,UAAU,EAAE,UAAU;YACtB,WAAW,EAAE,GAAG,MAAM,CAAC,eAAe,CAAC,IAAI,QAAQ,eAAe,GAAG;YACrE,aAAa,EAAE,IAAI;SACpB,EAAE,WAAW,CAAC,CAAC;QAEhB,IAAG,CAAC,cAAc,CAAC,OAAO,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,4CAA4C,UAAU,KAAK,cAAc,CAAC,YAAY,EAAE,CAAC,CAAC;QAC5G,CAAC;QAED,IAAI,eAAe,GAA2B,EAAE,CAAC;QACjD,KAAI,MAAM,MAAM,IAAI,cAAc,CAAC,OAAO,EAAE,CAAC;YAC3C,MAAM,oBAAoB,GAAyB,MAAM,EAAE,CAAC,eAAe,CAAuB,iBAAiB,EAAE,WAAW,CAAC,CAAC;YAClI,oBAAoB,CAAC,SAAS,EAAE,CAAC;YACjC,oBAAoB,CAAC,cAAc,GAAG,MAAM,CAAC,EAAE,CAAC;YAChD,eAAe,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAC7C,CAAC;QAED,OAAO,eAAe,CAAC;IACzB,CAAC;IAEO,iBAAiB,CAAC,KAAc;QACtC,OAAO,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAC;IAC/C,CAAC;CACF;AAlND,4DAkNC"}

package/dist/ProviderBase.d.ts

@@ -1,14 +1,27 @@
-import type { RecommendationRequest, RecommendationResult } from './Engine';
+import { RecommendationEntity, RecommendationItemEntity } from '@memberjunction/core-entities';
+import { UserInfo } from '@memberjunction/core';
+import { RecommendationRequest, RecommendationResult } from './generic/types';
 /**
  * Base class for all recommendation providers
  */
 export declare abstract class RecommendationProviderBase {
+    private _md;
+    private _ContextUser;
+    constructor(ContextUser: UserInfo);
+    get ContextUser(): UserInfo;
     /**
      * For each entry in the request.Recommendations array, the provider's external API is called to
      * produce zero or more {@link RecommendationItemEntity} records.
      *
      * @param request - The Recommendations to request from this provider
      */
-    abstract Recommend(request: Pick<RecommendationRequest, 'Recommendations'>): Promise<RecommendationResult>;
+    abstract Recommend(request: RecommendationRequest): Promise<RecommendationResult>;
+    /**
+     * This method is used by subclasses to update a Recommendation record in the database to set the RecommendationRunID column. In addition,
+     * this method will save all the RecommendationItem records associated with the Recommendation record and link them to the Recommendation record.
+     * @param recommendation
+     * @param RunID
+     */
+    protected SaveRecommendation(recommendation: RecommendationEntity, RunID: string, items: RecommendationItemEntity[]): Promise<boolean>;
 }
 //# sourceMappingURL=ProviderBase.d.ts.map

package/dist/ProviderBase.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ProviderBase.d.ts","sourceRoot":"","sources":["../src/ProviderBase.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAE5E;;GAEG;AACH,8BAAsB,0BAA0B;IAC9C;;;;;OAKG;aACa,SAAS,CAAC,OAAO,EAAE,IAAI,CAAC,qBAAqB,EAAE,iBAAiB,CAAC,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAClH"}
+{"version":3,"file":"ProviderBase.d.ts","sourceRoot":"","sources":["../src/ProviderBase.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAC/F,OAAO,EAAsB,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACpE,OAAO,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAE9E;;GAEG;AACH,8BAAsB,0BAA0B;IAC9C,OAAO,CAAC,GAAG,CAAW;IACtB,OAAO,CAAC,YAAY,CAAW;gBAEZ,WAAW,EAAE,QAAQ;IAKxC,IAAW,WAAW,IAAI,QAAQ,CAEjC;IAED;;;;;OAKG;aACa,SAAS,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAExF;;;;;OAKG;cACa,kBAAkB,CAAC,cAAc,EAAE,oBAAoB,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,wBAAwB,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC;CAoB7I"}

package/dist/ProviderBase.js

@@ -1,10 +1,42 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RecommendationProviderBase = void 0;
+const core_1 = require("@memberjunction/core");
 /**
  * Base class for all recommendation providers
  */
 class RecommendationProviderBase {
+    constructor(ContextUser) {
+        this._ContextUser = ContextUser;
+        this._md = new core_1.Metadata();
+    }
+    get ContextUser() {
+        return this._ContextUser;
+    }
+    /**
+     * This method is used by subclasses to update a Recommendation record in the database to set the RecommendationRunID column. In addition,
+     * this method will save all the RecommendationItem records associated with the Recommendation record and link them to the Recommendation record.
+     * @param recommendation
+     * @param RunID
+     */
+    async SaveRecommendation(recommendation, RunID, items) {
+        recommendation.RecommendationRunID = RunID;
+        const recommendationSaveResult = await recommendation.Save();
+        if (!recommendationSaveResult) {
+            (0, core_1.LogError)(`Error saving recommendation for ${recommendation.ID}`, undefined, recommendation.LatestResult);
+            return false;
+        }
+        let allSaved = true;
+        for (const item of items) {
+            item.RecommendationID = recommendation.ID;
+            const saveResult = await item.Save();
+            if (!saveResult) {
+                (0, core_1.LogError)(`Error saving recommendation item for recommendation ${recommendation.ID}`, undefined, item.LatestResult);
+                allSaved = false;
+            }
+        }
+        return allSaved;
+    }
 }
 exports.RecommendationProviderBase = RecommendationProviderBase;
 //# sourceMappingURL=ProviderBase.js.map

package/dist/ProviderBase.js.map

@@ -1 +1 @@
-{"version":3,"file":"ProviderBase.js","sourceRoot":"","sources":["../src/ProviderBase.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACH,MAAsB,0BAA0B;CAQ/C;AARD,gEAQC"}
+{"version":3,"file":"ProviderBase.js","sourceRoot":"","sources":["../src/ProviderBase.ts"],"names":[],"mappings":";;;AACA,+CAAoE;AAGpE;;GAEG;AACH,MAAsB,0BAA0B;IAI9C,YAAmB,WAAqB;QACtC,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,GAAG,GAAG,IAAI,eAAQ,EAAE,CAAC;IAC5B,CAAC;IAED,IAAW,WAAW;QACpB,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAUD;;;;;OAKG;IACO,KAAK,CAAC,kBAAkB,CAAC,cAAoC,EAAE,KAAa,EAAE,KAAiC;QACvH,cAAc,CAAC,mBAAmB,GAAG,KAAK,CAAC;QAC3C,MAAM,wBAAwB,GAAY,MAAM,cAAc,CAAC,IAAI,EAAE,CAAC;QACtE,IAAG,CAAC,wBAAwB,EAAE,CAAC;YAC7B,IAAA,eAAQ,EAAC,mCAAmC,cAAc,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,cAAc,CAAC,YAAY,CAAC,CAAC;YACzG,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,QAAQ,GAAY,IAAI,CAAC;QAC7B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,CAAC,gBAAgB,GAAG,cAAc,CAAC,EAAE,CAAC;YAC1C,MAAM,UAAU,GAAY,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;YAC9C,IAAG,CAAC,UAAU,EAAE,CAAC;gBACf,IAAA,eAAQ,EAAC,uDAAuD,cAAc,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;gBACnH,QAAQ,GAAG,KAAK,CAAC;YACnB,CAAC;QACH,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF;AA/CD,gEA+CC"}

package/dist/generic/types.d.ts

@@ -0,0 +1,83 @@
+import { UserInfo } from "@memberjunction/core";
+import { RecommendationEntity, RecommendationItemEntity, RecommendationProviderEntity, RecommendationRunEntity } from "@memberjunction/core-entities";
+/**
+ * Used to make requests to Recommendation providers
+ */
+export declare class RecommendationRequest {
+    /**
+     * The ID of the RecommendationRun record that will be created by the caller of a given provider. This must be created before a provider is called.
+     * This is done automatically by the Recommendation Engine and can be populated manually if for some reason you want to call a provider directly outside
+     * of the engine. This is a required field.
+     */
+    RunID?: string;
+    /**
+     * Array of the requested recommendations. When preparing a batch of recommendations to request, do NOT set the RecommendationRunID or attempt
+     * to save the Recommendation records. This will be done as the batch is processed. You cannot save a Recommendation record until a Run is created
+     * which is done by the RecommendationEngineBase.Recommend() method.
+     */
+    Recommendations?: RecommendationEntity[];
+    /**
+     * This is an optional field that can be passed in instead of the Recommendations field. If passed in,
+     * the Recommendations field will be populated with Recommendation Entities whose Primary key value matches any of the RecordIDs passed in.
+     */
+    EntityAndRecordsInfo?: {
+        /**
+         * The name of the entity that the RecordIDs belong to
+         */
+        EntityName: string;
+        /**
+         * The RecordIDs to fetch recommendations for. Note that if the record IDs
+         *
+         */
+        RecordIDs: Array<string | number>;
+    };
+    ListID?: string;
+    /**
+     * The specific provider to use for the request. Leave this undefined if you want to use the default provider.
+     */
+    Provider?: RecommendationProviderEntity;
+    /**
+     * UserInfo object to use when applicable.
+     */
+    CurrentUser?: UserInfo;
+    /**
+     * Additional options to pass to the provider
+     */
+    Options?: Record<string, any>;
+}
+/**
+ * This response is generated for each Recommend() request
+ */
+export declare class RecommendationResult {
+    Request: RecommendationRequest;
+    /**
+     * The Recommendation Run entity that was created by the recommendation engine
+     */
+    RecommendationRun?: RecommendationRunEntity;
+    /**
+     * The Recommendation Item Entities that were created by the recommendation provider
+     */
+    RecommendationItems?: RecommendationItemEntity[];
+    Success: boolean;
+    ErrorMessage: string;
+    constructor(request: RecommendationRequest);
+    /**
+     * Appends the provided warningMessage param to the ErrorMessage property,
+     * with "Warning: " prepended to the message and a newline character appended to the end.
+     * The value of the Success property is not changed.
+     */
+    AppendWarning(warningMessage: string): void;
+    /**
+     * Appends the provided errorMessage param to the ErrorMessage property,
+     * with "Error: " prepended to the message and a newline character appended to the end.
+     * Also sets the Success property to false.
+     */
+    AppendError(errorMessage: string): void;
+    /**
+     * Returns the ErrorMessage property as an array of strings.
+     * Useful in the event multiple errors or warnings were produced
+     * during the recommendation run.
+     */
+    GetErrorMessages(): string[];
+}
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/generic/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,4BAA4B,EAAE,uBAAuB,EAAE,MAAM,+BAA+B,CAAC;AAEtJ;;GAEG;AACH,qBAAa,qBAAqB;IAC9B;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,eAAe,CAAC,EAAE,oBAAoB,EAAE,CAAM;IAE9C;;;OAGG;IACH,oBAAoB,CAAC,EAAE;QACnB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QACnB;;;WAGG;QACH,SAAS,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,CAAA;KACpC,CAAA;IAED,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,4BAA4B,CAAC;IAExC;;OAEG;IACH,WAAW,CAAC,EAAE,QAAQ,CAAC;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CACjC;AAED;;GAEG;AACH,qBAAa,oBAAoB;IAC7B,OAAO,EAAE,qBAAqB,CAAC;IAC/B;;OAEG;IACH,iBAAiB,CAAC,EAAE,uBAAuB,CAAC;IAC5C;;OAEG;IACH,mBAAmB,CAAC,EAAE,wBAAwB,EAAE,CAAM;IACtD,OAAO,EAAE,OAAO,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;gBAET,OAAO,EAAE,qBAAqB;IAM1C;;;;OAIG;IACH,aAAa,CAAC,cAAc,EAAE,MAAM;IAIpC;;;;OAIG;IACH,WAAW,CAAC,YAAY,EAAE,MAAM;IAKhC;;;;OAIG;IACH,gBAAgB,IAAI,MAAM,EAAE;CAG/B"}

package/dist/generic/types.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RecommendationResult = exports.RecommendationRequest = void 0;
+/**
+ * Used to make requests to Recommendation providers
+ */
+class RecommendationRequest {
+    constructor() {
+        /**
+         * Array of the requested recommendations. When preparing a batch of recommendations to request, do NOT set the RecommendationRunID or attempt
+         * to save the Recommendation records. This will be done as the batch is processed. You cannot save a Recommendation record until a Run is created
+         * which is done by the RecommendationEngineBase.Recommend() method.
+         */
+        this.Recommendations = [];
+    }
+}
+exports.RecommendationRequest = RecommendationRequest;
+/**
+ * This response is generated for each Recommend() request
+ */
+class RecommendationResult {
+    constructor(request) {
+        /**
+         * The Recommendation Item Entities that were created by the recommendation provider
+         */
+        this.RecommendationItems = [];
+        this.Request = request;
+        this.Success = true;
+        this.ErrorMessage = "";
+    }
+    /**
+     * Appends the provided warningMessage param to the ErrorMessage property,
+     * with "Warning: " prepended to the message and a newline character appended to the end.
+     * The value of the Success property is not changed.
+     */
+    AppendWarning(warningMessage) {
+        this.ErrorMessage += `Warning: ${warningMessage} \n`;
+    }
+    /**
+     * Appends the provided errorMessage param to the ErrorMessage property,
+     * with "Error: " prepended to the message and a newline character appended to the end.
+     * Also sets the Success property to false.
+     */
+    AppendError(errorMessage) {
+        this.Success = false;
+        this.ErrorMessage += `Error: ${errorMessage} \n`;
+    }
+    /**
+     * Returns the ErrorMessage property as an array of strings.
+     * Useful in the event multiple errors or warnings were produced
+     * during the recommendation run.
+     */
+    GetErrorMessages() {
+        return this.ErrorMessage.split('\n');
+    }
+}
+exports.RecommendationResult = RecommendationResult;
+//# sourceMappingURL=types.js.map

package/dist/generic/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/generic/types.ts"],"names":[],"mappings":";;;AAGA;;GAEG;AACH,MAAa,qBAAqB;IAAlC;QAQI;;;;WAIG;QACH,oBAAe,GAA4B,EAAE,CAAC;IAkClD,CAAC;CAAA;AA/CD,sDA+CC;AAED;;GAEG;AACH,MAAa,oBAAoB;IAa7B,YAAY,OAA8B;QAP1C;;WAEG;QACH,wBAAmB,GAAgC,EAAE,CAAC;QAKlD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,cAAsB;QAChC,IAAI,CAAC,YAAY,IAAI,YAAY,cAAc,KAAK,CAAC;IACzD,CAAC;IAED;;;;OAIG;IACH,WAAW,CAAC,YAAoB;QAC5B,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC,YAAY,IAAI,UAAU,YAAY,KAAK,CAAC;IACrD,CAAC;IAED;;;;OAIG;IACH,gBAAgB;QACZ,OAAO,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;CACJ;AA9CD,oDA8CC"}

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export * from './Engine';
 export * from './ProviderBase';
+export * from './generic/types';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC"}

package/dist/index.js

@@ -16,4 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./Engine"), exports);
 __exportStar(require("./ProviderBase"), exports);
+__exportStar(require("./generic/types"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,iDAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,iDAA+B;AAC/B,kDAAgC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memberjunction/ai-recommendations",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "MemberJunction Recommendations Engine",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -19,9 +19,9 @@
     "typescript": "^5.4.5"
   },
   "dependencies": {
-    "@memberjunction/global": "2.4.0",
-    "@memberjunction/core": "2.4.0",
-    "@memberjunction/core-entities": "2.4.0",
-    "@memberjunction/ai": "2.4.0"
+    "@memberjunction/global": "2.5.0",
+    "@memberjunction/core": "2.5.0",
+    "@memberjunction/core-entities": "2.5.0",
+    "@memberjunction/ai": "2.5.0"
   }
 }