@memberjunction/entity-communications-server 1.5.3

package/dist/entity-communications.d.ts

@@ -0,0 +1,21 @@
+import { Message } from "@memberjunction/communication-types";
+import { RunViewParams } from "@memberjunction/core";
+import { EntityCommunicationsEngineBase } from "@memberjunction/entity-communications-base";
+/**
+ * Server-side implementation of the entity communications engine
+ */
+export declare class EntityCommunicationsEngine extends EntityCommunicationsEngineBase {
+    /**
+     * Executes a given message request against a view of records for a given entity
+     * @param entityID
+     * @param runViewParams
+     * @param providerName
+     * @param providerMessageTypeName
+     * @param message
+     */
+    RunEntityCommunication(entityID: number, runViewParams: RunViewParams, providerName: string, providerMessageTypeName: string, message: Message): Promise<{
+        Success: boolean;
+        ErrorMessage: string;
+    }>;
+}
+//# sourceMappingURL=entity-communications.d.ts.map

package/dist/entity-communications.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity-communications.d.ts","sourceRoot":"","sources":["../src/entity-communications.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,qCAAqC,CAAC;AAC9D,OAAO,EAAqB,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACxE,OAAO,EAAE,8BAA8B,EAAE,MAAM,4CAA4C,CAAC;AAG5F;;GAEG;AACH,qBAAa,0BAA2B,SAAQ,8BAA8B;IAC1E;;;;;;;OAOG;IACU,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,YAAY,EAAE,MAAM,EAAE,uBAAuB,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC;QAAC,OAAO,EAAE,OAAO,CAAC;QAAC,YAAY,EAAE,MAAM,CAAA;KAAC,CAAC;CA2DlN"}

package/dist/entity-communications.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntityCommunicationsEngine = void 0;
+const communication_engine_1 = require("@memberjunction/communication-engine");
+const core_1 = require("@memberjunction/core");
+const entity_communications_base_1 = require("@memberjunction/entity-communications-base");
+/**
+ * Server-side implementation of the entity communications engine
+ */
+class EntityCommunicationsEngine extends entity_communications_base_1.EntityCommunicationsEngineBase {
+    /**
+     * Executes a given message request against a view of records for a given entity
+     * @param entityID
+     * @param runViewParams
+     * @param providerName
+     * @param providerMessageTypeName
+     * @param message
+     */
+    async RunEntityCommunication(entityID, runViewParams, providerName, providerMessageTypeName, message) {
+        this.TryThrowIfNotLoaded();
+        const md = new core_1.Metadata();
+        const entityInfo = md.Entities.find(e => e.ID === entityID);
+        if (!entityInfo)
+            throw new Error(`Entity ${entityID} not found`);
+        if (!this.EntitySupportsCommunication(entityID)) {
+            throw new Error(`Entity ${entityID} does not support communication`);
+        }
+        await communication_engine_1.CommunicationEngine.Instance.Config(false, this.ContextUser);
+        const provider = communication_engine_1.CommunicationEngine.Instance.Providers.find(p => p.Name.trim().toLowerCase() === providerName.trim().toLowerCase());
+        if (!provider)
+            throw new Error(`Provider ${providerName} not found`);
+        const providerMessageType = provider.MessageTypes.find(mt => mt.Name.trim().toLowerCase() === providerMessageTypeName.trim().toLowerCase());
+        const entityMessageTypes = this.GetEntityCommunicationMessageTypes(entityID);
+        const entityMessageType = entityMessageTypes.find(m => m.BaseMessageTypeID === providerMessageType.CommunicationBaseMessageTypeID);
+        if (!entityMessageType) {
+            throw new Error(`Entity ${entityID} does not support message type ${providerMessageType.CommunicationBaseMessageType}`);
+        }
+        // we have now validated we are good on the message type requested...
+        // next up we will figure out which field to use for the entity, starting at the entity level and then going to the record level, IF the entity has
+        // a PreferredCommunicationField we will flag that here as recordLevelPref = true
+        const recordLevelPref = entityInfo.PreferredCommunicationField?.length > 0;
+        // get the highest priority field within the entityMessageType.communicationFields property
+        const entityLevelPrefField = entityMessageType.CommunicationFields.sort((a, b) => a.Priority - b.Priority)[0];
+        // next our main job here is to run the view, get all the records, and then call the communication engine
+        const rv = new core_1.RunView();
+        const result = await rv.RunView(runViewParams, this.ContextUser);
+        if (result && result.Success) {
+            // have the results, now we can map the results to the types the comm engine needs and call SendMessages() in the comm engine
+            await communication_engine_1.CommunicationEngine.Instance.Config(false, this.ContextUser);
+            const recipients = result.Results.map(r => {
+                // in the below we get the VALUE of the record level preferred field if it exists, otherwise we get the value of the entity level preferred field
+                const ToValue = !recordLevelPref ? r[entityLevelPrefField.FieldName] : r[r[entityInfo.PreferredCommunicationField]];
+                return {
+                    To: ToValue,
+                    ContextData: r
+                };
+            });
+            const sendResult = await communication_engine_1.CommunicationEngine.Instance.SendMessages(providerName, providerMessageTypeName, message, recipients);
+            if (sendResult && sendResult.length === recipients.length) {
+                // make sure none of the messages failed
+                return {
+                    Success: !sendResult.some(r => !r.Success),
+                    ErrorMessage: sendResult.filter(r => !r.Success).map(r => r.Error).join('; ')
+                };
+            }
+        }
+        else {
+            throw new Error(`Failed to run view ${runViewParams.ViewName}: ${result.ErrorMessage}`);
+        }
+    }
+}
+exports.EntityCommunicationsEngine = EntityCommunicationsEngine;
+//# sourceMappingURL=entity-communications.js.map

package/dist/entity-communications.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entity-communications.js","sourceRoot":"","sources":["../src/entity-communications.ts"],"names":[],"mappings":";;;AAAA,+EAA2E;AAE3E,+CAAwE;AACxE,2FAA4F;AAG5F;;GAEG;AACH,MAAa,0BAA2B,SAAQ,2DAA8B;IAC1E;;;;;;;OAOG;IACI,KAAK,CAAC,sBAAsB,CAAC,QAAgB,EAAE,aAA4B,EAAE,YAAoB,EAAE,uBAA+B,EAAE,OAAgB;QACvJ,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAE3B,MAAM,EAAE,GAAG,IAAI,eAAQ,EAAE,CAAC;QAC1B,MAAM,UAAU,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,QAAQ,CAAC,CAAC;QAC5D,IAAI,CAAC,UAAU;YACX,MAAM,IAAI,KAAK,CAAC,UAAU,QAAQ,YAAY,CAAC,CAAC;QAEpD,IAAI,CAAC,IAAI,CAAC,2BAA2B,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC9C,MAAM,IAAI,KAAK,CAAC,UAAU,QAAQ,iCAAiC,CAAC,CAAC;QACzE,CAAC;QAED,MAAM,0CAAmB,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAEnE,MAAM,QAAQ,GAAG,0CAAmB,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,KAAK,YAAY,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;QACrI,IAAI,CAAC,QAAQ;YACT,MAAM,IAAI,KAAK,CAAC,YAAY,YAAY,YAAY,CAAC,CAAC;QAC1D,MAAM,mBAAmB,GAAG,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,KAAK,uBAAuB,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;QAE5I,MAAM,kBAAkB,GAAG,IAAI,CAAC,kCAAkC,CAAC,QAAQ,CAAC,CAAC;QAC7E,MAAM,iBAAiB,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,iBAAiB,KAAK,mBAAmB,CAAC,8BAA8B,CAAC,CAAC;QACnI,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,UAAU,QAAQ,kCAAkC,mBAAmB,CAAC,4BAA4B,EAAE,CAAC,CAAC;QAC5H,CAAC;QAED,qEAAqE;QACrE,mJAAmJ;QACnJ,iFAAiF;QACjF,MAAM,eAAe,GAAG,UAAU,CAAC,2BAA2B,EAAE,MAAM,GAAG,CAAC,CAAC;QAC3E,2FAA2F;QAC3F,MAAM,oBAAoB,GAAG,iBAAiB,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QAE9G,yGAAyG;QACzG,MAAM,EAAE,GAAG,IAAI,cAAO,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACjE,IAAI,MAAM,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YAC3B,6HAA6H;YAC7H,MAAM,0CAAmB,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;YACnE,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE;gBACtC,iJAAiJ;gBACjJ,MAAM,OAAO,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,2BAA2B,CAAC,CAAC,CAAC;gBACpH,OAAO;oBACH,EAAE,EAAE,OAAO;oBACX,WAAW,EAAE,CAAC;iBACjB,CAAC;YACN,CAAC,CAAC,CAAA;YACF,MAAM,UAAU,GAAG,MAAM,0CAAmB,CAAC,QAAQ,CAAC,YAAY,CAAC,YAAY,EAAE,uBAAuB,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;YAC/H,IAAI,UAAU,IAAI,UAAU,CAAC,MAAM,KAAK,UAAU,CAAC,MAAM,EAAE,CAAC;gBACxD,wCAAwC;gBACxC,OAAO;oBACH,OAAO,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;oBAC1C,YAAY,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;iBAChF,CAAC;YACN,CAAC;QACL,CAAC;aACI,CAAC;YACF,MAAM,IAAI,KAAK,CAAC,sBAAsB,aAAa,CAAC,QAAQ,KAAK,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;QAC5F,CAAC;IACL,CAAC;CACJ;AApED,gEAoEC"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './entity-communications';
+//# 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":"AACA,cAAc,yBAAyB,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 });
+// PUBLIC API SURFACE AREA
+__exportStar(require("./entity-communications"), 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,0BAA0B;AAC1B,0DAAwC"}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@memberjunction/entity-communications-server",
+  "version": "1.5.3",
+  "description": "MemberJunction: Library that connects the MJ entities framework to the communication framework",
+  "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/communication-engine": "1.5.3",
+    "@memberjunction/entity-communications-base": "1.5.3"
+  }
+}