@memberjunction/entity-communications-base 1.8.1 → 2.1.0

package/dist/base.d.ts

@@ -1,14 +1,31 @@
 import { BaseEngine, RunViewParams, UserInfo } from "@memberjunction/core";
 import { EntityCommunicationFieldEntity, EntityCommunicationMessageTypeEntity } from "@memberjunction/core-entities";
-import { Message } from '@memberjunction/communication-types';
+import { Message, ProcessedMessage } from '@memberjunction/communication-types';
 export declare class EntityCommunicationMessageTypeExtended extends EntityCommunicationMessageTypeEntity {
     CommunicationFields: EntityCommunicationFieldEntity[];
 }
+export declare class EntityCommunicationParams {
+    EntityID: string;
+    RunViewParams: RunViewParams;
+    ProviderName: string;
+    ProviderMessageTypeName: string;
+    Message: Message;
+    PreviewOnly?: boolean;
+    IncludeProcessedMessages?: boolean;
+}
+export declare class EntityCommunicationResultItem {
+    RecipientData: any;
+    Message: ProcessedMessage;
+}
+export declare class EntityCommunicationResult {
+    Success: boolean;
+    ErrorMessage?: string;
+    Results?: EntityCommunicationResultItem[];
+}
 export declare abstract class EntityCommunicationsEngineBase extends BaseEngine<EntityCommunicationsEngineBase> {
     Config(forceRefresh?: boolean, contextUser?: UserInfo): Promise<void>;
     static get Instance(): EntityCommunicationsEngineBase;
-    private _EntityCommunicationMessageTypes;
-    private _EntityCommunicationFields;
+    private _Metadata;
     get EntityCommunicationMessageTypes(): EntityCommunicationMessageTypeExtended[];
     get EntityCommunicationFields(): EntityCommunicationFieldEntity[];
     protected AdditionalLoading(contextUser?: UserInfo): Promise<void>;
@@ -17,23 +34,16 @@ export declare abstract class EntityCommunicationsEngineBase extends BaseEngine<
      * @param entityID
      * @returns
      */
-    GetEntityCommunicationMessageTypes(entityID: number): EntityCommunicationMessageTypeExtended[];
+    GetEntityCommunicationMessageTypes(entityID: string): EntityCommunicationMessageTypeExtended[];
     /**
      * Returns true if the specified entity has any communication message types
      * @param entityID
      */
-    EntitySupportsCommunication(entityID: number): boolean;
+    EntitySupportsCommunication(entityID: string): boolean;
     /**
      * Executes a given message request against a view of records for a given entity
-     * @param entityID
-     * @param runViewParams
-     * @param providerName
-     * @param providerMessageTypeName
-     * @param message
+     * @param params
      */
-    abstract RunEntityCommunication(entityID: number, runViewParams: RunViewParams, providerName: string, providerMessageTypeName: string, message: Message): Promise<{
-        Success: boolean;
-        ErrorMessage: string;
-    }>;
+    abstract RunEntityCommunication(params: EntityCommunicationParams): Promise<EntityCommunicationResult>;
 }
 //# sourceMappingURL=base.d.ts.map

package/dist/base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAwC,aAAa,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACjH,OAAO,EAAE,8BAA8B,EAAE,oCAAoC,EAAE,MAAM,+BAA+B,CAAC;AAErH,OAAO,EAAE,OAAO,EAAE,MAAM,qCAAqC,CAAC;AAE9D,qBACa,sCAAuC,SAAQ,oCAAoC;IACrF,mBAAmB,EAAE,8BAA8B,EAAE,CAAM;CACrE;AAED,8BAAsB,8BAA+B,SAAQ,UAAU,CAAC,8BAA8B,CAAC;IACtF,MAAM,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,QAAQ;IAclE,WAAkB,QAAQ,IAAI,8BAA8B,CAE3D;IAED,OAAO,CAAC,gCAAgC,CAAgD;IACxF,OAAO,CAAC,0BAA0B,CAAwC;IAC1E,IAAW,+BAA+B,IAAI,sCAAsC,EAAE,CAErF;IACD,IAAW,yBAAyB,IAAI,8BAA8B,EAAE,CAEvE;cAEe,iBAAiB,CAAC,WAAW,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAOxE;;;;OAIG;IACI,kCAAkC,CAAC,QAAQ,EAAE,MAAM,GAAG,sCAAsC,EAAE;IAKrG;;;OAGG;IACI,2BAA2B,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAa7D;;;;;;;OAOG;aACa,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;CACrN"}
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAwC,aAAa,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACjH,OAAO,EAAE,8BAA8B,EAAE,oCAAoC,EAAE,MAAM,+BAA+B,CAAC;AAErH,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAA2B,MAAM,qCAAqC,CAAC;AAEzG,qBACa,sCAAuC,SAAQ,oCAAoC;IACrF,mBAAmB,EAAE,8BAA8B,EAAE,CAAM;CACrE;AAGD,qBAAa,yBAAyB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,aAAa,CAAA;IAC5B,YAAY,EAAE,MAAM,CAAA;IACpB,uBAAuB,EAAE,MAAM,CAAA;IAC/B,OAAO,EAAE,OAAO,CAAA;IAChB,WAAW,CAAC,EAAE,OAAO,CAAQ;IAC7B,wBAAwB,CAAC,EAAE,OAAO,CAAQ;CAC7C;AACD,qBAAa,6BAA6B;IACtC,aAAa,EAAE,GAAG,CAAA;IAClB,OAAO,EAAE,gBAAgB,CAAA;CAC5B;AACD,qBAAa,yBAAyB;IAClC,OAAO,EAAE,OAAO,CAAA;IAChB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,OAAO,CAAC,EAAE,6BAA6B,EAAE,CAAA;CAC5C;AAED,8BAAsB,8BAA+B,SAAQ,UAAU,CAAC,8BAA8B,CAAC;IACtF,MAAM,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,QAAQ;IASlE,WAAkB,QAAQ,IAAI,8BAA8B,CAE3D;IAED,OAAO,CAAC,SAAS,CAGwD;IAEzE,IAAW,+BAA+B,IAAI,sCAAsC,EAAE,CAErF;IACD,IAAW,yBAAyB,IAAI,8BAA8B,EAAE,CAEvE;cAEe,iBAAiB,CAAC,WAAW,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IASxE;;;;OAIG;IACI,kCAAkC,CAAC,QAAQ,EAAE,MAAM,GAAG,sCAAsC,EAAE;IAKrG;;;OAGG;IACI,2BAA2B,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAa7D;;;OAGG;aACa,sBAAsB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,yBAAyB,CAAC;CAEhH"}

package/dist/base.js

@@ -6,10 +6,11 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EntityCommunicationsEngineBase = exports.EntityCommunicationMessageTypeExtended = void 0;
+exports.EntityCommunicationsEngineBase = exports.EntityCommunicationResult = exports.EntityCommunicationResultItem = exports.EntityCommunicationParams = exports.EntityCommunicationMessageTypeExtended = void 0;
 const core_1 = require("@memberjunction/core");
 const core_entities_1 = require("@memberjunction/core-entities");
 const global_1 = require("@memberjunction/global");
+const communication_types_1 = require("@memberjunction/communication-types");
 let EntityCommunicationMessageTypeExtended = class EntityCommunicationMessageTypeExtended extends core_entities_1.EntityCommunicationMessageTypeEntity {
     constructor() {
         super(...arguments);
@@ -20,36 +21,44 @@ exports.EntityCommunicationMessageTypeExtended = EntityCommunicationMessageTypeE
 exports.EntityCommunicationMessageTypeExtended = EntityCommunicationMessageTypeExtended = __decorate([
     (0, global_1.RegisterClass)(core_1.BaseEntity, 'Entity Communication Message Types')
 ], EntityCommunicationMessageTypeExtended);
+class EntityCommunicationParams {
+    constructor() {
+        this.PreviewOnly = false;
+        this.IncludeProcessedMessages = false;
+    }
+}
+exports.EntityCommunicationParams = EntityCommunicationParams;
+class EntityCommunicationResultItem {
+}
+exports.EntityCommunicationResultItem = EntityCommunicationResultItem;
+class EntityCommunicationResult {
+}
+exports.EntityCommunicationResult = EntityCommunicationResult;
 class EntityCommunicationsEngineBase extends core_1.BaseEngine {
     constructor() {
         super(...arguments);
-        this._EntityCommunicationMessageTypes = [];
-        this._EntityCommunicationFields = [];
+        this._Metadata = { EntityCommunicationMessageTypes: [], EntityCommunicationFields: [] };
     }
     async Config(forceRefresh, contextUser) {
-        const c = [
-            {
-                EntityName: "Entity Communication Message Types",
-                PropertyName: "_EntityCommunicationMessageTypes"
-            },
-            {
-                EntityName: "Entity Communication Fields",
-                PropertyName: "_EntityCommunicationFields"
-            }
-        ];
-        return await this.Load(c, forceRefresh, contextUser);
+        // just rely on the metadata from the base engine, can do extra loading here down the road as needed
+        // it is faster to use the base engine's metadata than to load it again here even though the metadata
+        // is cached we still have to check to see if the dataset is up to date and that takes time
+        await communication_types_1.CommunicationEngineBase.Instance.Config(forceRefresh, contextUser);
+        await this.Load([], forceRefresh, contextUser); // even though we have NO configs, we need to call Load so that the lifecycle of this object is properly managed where the Loaded flag is set and AdditionalLoading is called
     }
     static get Instance() {
         return super.getInstance();
     }
     get EntityCommunicationMessageTypes() {
-        return this._EntityCommunicationMessageTypes;
+        return this._Metadata.EntityCommunicationMessageTypes;
     }
     get EntityCommunicationFields() {
-        return this._EntityCommunicationFields;
+        return this._Metadata.EntityCommunicationFields;
     }
     async AdditionalLoading(contextUser) {
         // post-process the fields to be linked to the message types they're part of 
+        this._Metadata.EntityCommunicationFields = communication_types_1.CommunicationEngineBase.Instance.Metadata.EntityCommunicationFields;
+        this._Metadata.EntityCommunicationMessageTypes = communication_types_1.CommunicationEngineBase.Instance.Metadata.EntityCommunicationMessageTypes;
         this.EntityCommunicationMessageTypes.forEach(m => {
             m.CommunicationFields = this.EntityCommunicationFields.filter(f => f.EntityCommunicationMessageTypeID === m.ID);
         });

package/dist/base.js.map

@@ -1 +1 @@
-{"version":3,"file":"base.js","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":";;;;;;;;;AAAA,+CAAiH;AACjH,iEAAqH;AACrH,mDAAuD;AAIhD,IAAM,sCAAsC,GAA5C,MAAM,sCAAuC,SAAQ,oDAAoC;IAAzF;;QACI,wBAAmB,GAAqC,EAAE,CAAC;IACtE,CAAC;CAAA,CAAA;AAFY,wFAAsC;iDAAtC,sCAAsC;IADlD,IAAA,sBAAa,EAAC,iBAAU,EAAE,oCAAoC,CAAC;GACnD,sCAAsC,CAElD;AAED,MAAsB,8BAA+B,SAAQ,iBAA0C;IAAvG;;QAmBY,qCAAgC,GAA6C,EAAE,CAAC;QAChF,+BAA0B,GAAqC,EAAE,CAAC;IAmD9E,CAAC;IAtEU,KAAK,CAAC,MAAM,CAAC,YAAsB,EAAE,WAAsB;QAC9D,MAAM,CAAC,GAAwC;YAC3C;gBACI,UAAU,EAAE,oCAAoC;gBAChD,YAAY,EAAE,kCAAkC;aACnD;YACD;gBACI,UAAU,EAAE,6BAA6B;gBACzC,YAAY,EAAE,4BAA4B;aAC7C;SACJ,CAAC;QACF,OAAO,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;IACzD,CAAC;IAEM,MAAM,KAAK,QAAQ;QACtB,OAAO,KAAK,CAAC,WAAW,EAAkC,CAAC;IAC/D,CAAC;IAID,IAAW,+BAA+B;QACtC,OAAO,IAAI,CAAC,gCAAgC,CAAC;IACjD,CAAC;IACD,IAAW,yBAAyB;QAChC,OAAO,IAAI,CAAC,0BAA0B,CAAC;IAC3C,CAAC;IAES,KAAK,CAAC,iBAAiB,CAAC,WAAsB;QACpD,6EAA6E;QAC7E,IAAI,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;YAC7C,CAAC,CAAC,mBAAmB,GAAG,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gCAAgC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;QACpH,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;OAIG;IACI,kCAAkC,CAAC,QAAgB;QACtD,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC3B,OAAO,IAAI,CAAC,+BAA+B,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC;IACrF,CAAC;IAED;;;OAGG;IACI,2BAA2B,CAAC,QAAgB;QAC/C,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC3B,OAAO,IAAI,CAAC,kCAAkC,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IACxE,CAAC;CAmBJ;AAvED,wEAuEC"}
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":";;;;;;;;;AAAA,+CAAiH;AACjH,iEAAqH;AACrH,mDAAuD;AACvD,6EAAyG;AAGlG,IAAM,sCAAsC,GAA5C,MAAM,sCAAuC,SAAQ,oDAAoC;IAAzF;;QACI,wBAAmB,GAAqC,EAAE,CAAC;IACtE,CAAC;CAAA,CAAA;AAFY,wFAAsC;iDAAtC,sCAAsC;IADlD,IAAA,sBAAa,EAAC,iBAAU,EAAE,oCAAoC,CAAC;GACnD,sCAAsC,CAElD;AAGD,MAAa,yBAAyB;IAAtC;QAMI,gBAAW,GAAa,KAAK,CAAA;QAC7B,6BAAwB,GAAa,KAAK,CAAA;IAC9C,CAAC;CAAA;AARD,8DAQC;AACD,MAAa,6BAA6B;CAGzC;AAHD,sEAGC;AACD,MAAa,yBAAyB;CAIrC;AAJD,8DAIC;AAED,MAAsB,8BAA+B,SAAQ,iBAA0C;IAAvG;;QAcY,cAAS,GAGb,EAAC,+BAA+B,EAAE,EAAE,EAAE,yBAAyB,EAAE,EAAE,EAAC,CAAC;IAmD7E,CAAC;IAnEU,KAAK,CAAC,MAAM,CAAC,YAAsB,EAAE,WAAsB;QAC9D,oGAAoG;QACpG,qGAAqG;QACrG,2FAA2F;QAC3F,MAAM,6CAAuB,CAAC,QAAQ,CAAC,MAAM,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;QACzE,MAAM,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC,CAAC,6KAA6K;IACjO,CAAC;IAGM,MAAM,KAAK,QAAQ;QACtB,OAAO,KAAK,CAAC,WAAW,EAAkC,CAAC;IAC/D,CAAC;IAOD,IAAW,+BAA+B;QACtC,OAAO,IAAI,CAAC,SAAS,CAAC,+BAA+B,CAAC;IAC1D,CAAC;IACD,IAAW,yBAAyB;QAChC,OAAO,IAAI,CAAC,SAAS,CAAC,yBAAyB,CAAC;IACpD,CAAC;IAES,KAAK,CAAC,iBAAiB,CAAC,WAAsB;QACpD,6EAA6E;QAC7E,IAAI,CAAC,SAAS,CAAC,yBAAyB,GAAG,6CAAuB,CAAC,QAAQ,CAAC,QAAQ,CAAC,yBAAyB,CAAC;QAC/G,IAAI,CAAC,SAAS,CAAC,+BAA+B,GAA6C,6CAAuB,CAAC,QAAQ,CAAC,QAAQ,CAAC,+BAA+B,CAAC;QACrK,IAAI,CAAC,+BAA+B,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;YAC7C,CAAC,CAAC,mBAAmB,GAAG,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gCAAgC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC;QACpH,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;OAIG;IACI,kCAAkC,CAAC,QAAgB;QACtD,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC3B,OAAO,IAAI,CAAC,+BAA+B,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC;IACrF,CAAC;IAED;;;OAGG;IACI,2BAA2B,CAAC,QAAgB;QAC/C,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC3B,OAAO,IAAI,CAAC,kCAAkC,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;IACxE,CAAC;CAgBJ;AApED,wEAoEC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@memberjunction/entity-communications-base",
-  "version": "1.8.1",
+  "version": "2.1.0",
   "description": "MemberJunction: Base Types for Client/Server use with Entity Communications Engine",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -19,9 +19,9 @@
     "typescript": "^5.4.5"
   },
   "dependencies": {
-    "@memberjunction/global": "1.8.1",
-    "@memberjunction/core": "1.8.1",
-    "@memberjunction/core-entities": "1.8.1",
-    "@memberjunction/communication-types": "1.8.1"
+    "@memberjunction/global": "2.1.0",
+    "@memberjunction/core": "2.1.0",
+    "@memberjunction/core-entities": "2.1.0",
+    "@memberjunction/communication-types": "2.1.0"
   }
 }