@memberjunction/ai-recommendations 1.5.3

package/dist/Engine.d.ts

@@ -0,0 +1,37 @@
+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);
+}
+/**
+ * Engine class to be used for running all recommendation requests
+ */
+export declare class RecommendationEngineBase extends BaseEngine<RecommendationEngineBase> {
+    private _RecommendationProviders;
+    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>;
+}
+//# sourceMappingURL=Engine.d.ts.map

package/dist/Engine.d.ts.map

@@ -0,0 +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"}

package/dist/Engine.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RecommendationEngineBase = exports.RecommendationResult = exports.RecommendationRequest = 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
+ */
+class RecommendationEngineBase extends core_1.BaseEngine {
+    constructor() {
+        super(...arguments);
+        this._RecommendationProviders = [];
+    }
+    async Config(forceRefresh, contextUser) {
+        const params = [
+            {
+                PropertyName: '_RecommendationProviders',
+                EntityName: 'Recommendation Providers',
+            },
+        ];
+        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];
+        if (!provider) {
+            throw new Error('No recommendation provider available');
+        }
+        // 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}`);
+        }
+        // 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}`);
+            }
+        }
+        else {
+            run.Status = 'Error';
+            run.Description = result.ErrorMessage;
+            if (!(await run.Save())) {
+                throw new Error(`Error saving Errored RecommendationRun with ID: ${runID}`);
+            }
+        }
+        return run;
+    }
+}
+exports.RecommendationEngineBase = RecommendationEngineBase;
+//# sourceMappingURL=Engine.js.map

package/dist/Engine.js.map

@@ -0,0 +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"}

package/dist/ProviderBase.d.ts

@@ -0,0 +1,14 @@
+import type { RecommendationRequest, RecommendationResult } from './Engine';
+/**
+ * Base class for all recommendation providers
+ */
+export declare abstract class RecommendationProviderBase {
+    /**
+     * 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>;
+}
+//# sourceMappingURL=ProviderBase.d.ts.map

package/dist/ProviderBase.d.ts.map

@@ -0,0 +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"}

package/dist/ProviderBase.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RecommendationProviderBase = void 0;
+/**
+ * Base class for all recommendation providers
+ */
+class RecommendationProviderBase {
+}
+exports.RecommendationProviderBase = RecommendationProviderBase;
+//# sourceMappingURL=ProviderBase.js.map

package/dist/ProviderBase.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProviderBase.js","sourceRoot":"","sources":["../src/ProviderBase.ts"],"names":[],"mappings":";;;AAEA;;GAEG;AACH,MAAsB,0BAA0B;CAQ/C;AARD,gEAQC"}

package/dist/index.d.ts

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

package/dist/index.d.ts.map

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

package/dist/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Engine"), exports);
+__exportStar(require("./ProviderBase"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

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

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@memberjunction/ai-recommendations",
+  "version": "1.5.3",
+  "description": "MemberJunction Recommendations Engine",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "scripts": {
+    "start": "ts-node-dev src/index.ts",
+    "build": "tsc",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "MemberJunction.com",
+  "license": "ISC",
+  "devDependencies": {
+    "ts-node-dev": "^2.0.0",
+    "typescript": "^5.4.5"
+  },
+  "dependencies": {
+    "@memberjunction/global": "1.5.3",
+    "@memberjunction/core": "1.5.3",
+    "@memberjunction/core-entities": "1.5.3",
+    "@memberjunction/ai": "1.5.3"
+  }
+}

package/readme.md

@@ -0,0 +1,2 @@
+# @memberjunction/ai-recommendations
+Engine for integration with AI recommendation engines such as Rex by rasa.io