@memberjunction/communication-types 1.5.3

package/dist/BaseEngine.d.ts

@@ -0,0 +1,43 @@
+import { BaseEngine, UserInfo } from "@memberjunction/core";
+import { CommunicationBaseMessageTypeEntity, CommunicationLogEntity, CommunicationRunEntity } from "@memberjunction/core-entities";
+import { CommunicationProviderEntityExtended, ProcessedMessage } from "./BaseProvider";
+/**
+ * Base class for communications. This class can be sub-classed if desired if you would like to modify the logic across ALL actions. To do so, sub-class this class and use the
+ * @RegisterClass decorator from the @memberjunction/global package to register your sub-class with the ClassFactory. This will cause your sub-class to be used instead of this base class when the Metadata object insantiates the ActionEngine.
+ */
+export declare class CommunicationEngineBase extends BaseEngine<CommunicationEngineBase> {
+    /**
+     * Returns the global instance of the class. This is a singleton class, so there is only one instance of it in the application. Do not directly create new instances of it, always use this method to get the instance.
+     */
+    static get Instance(): CommunicationEngineBase;
+    private _BaseMessageTypes;
+    private _Providers;
+    private _ProviderMessageTypes;
+    /**
+     * This method is called to configure the engine. It loads the metadata and caches it in the GlobalObjectStore. You must call this method before doing anything else with the engine.
+     * If this method was previously run on the instance of the engine, it will return immediately without re-loading the metadata. If you want to force a reload of the metadata, you can pass true for the forceReload parameter.
+     * @param forceRefresh If true, the metadata will be loaded from the database even if it was previously loaded.
+     * @param contextUser If you are running on the server side you must pass this in, but it is not required in an environment where a user is authenticated directly, e.g. a browser or other client.
+     */
+    Config(forceRefresh?: boolean, contextUser?: UserInfo): Promise<void>;
+    protected AdditionalLoading(contextUser?: UserInfo): Promise<void>;
+    get BaseMessageTypes(): CommunicationBaseMessageTypeEntity[];
+    get Providers(): CommunicationProviderEntityExtended[];
+    /**
+     * Starts a communication run
+     */
+    protected StartRun(): Promise<CommunicationRunEntity>;
+    /**
+     * Ends a communication run
+     * @param run
+     * @returns
+     */
+    protected EndRun(run: CommunicationRunEntity): Promise<boolean>;
+    /**
+     * This method creates a new Communication Log record and saves it to the database with a status of pending. It returns the new Communication Log record.
+     * @param processedMessage
+     * @param run
+     */
+    protected StartLog(processedMessage: ProcessedMessage, run?: CommunicationRunEntity): Promise<CommunicationLogEntity>;
+}
+//# sourceMappingURL=BaseEngine.d.ts.map

package/dist/BaseEngine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseEngine.d.ts","sourceRoot":"","sources":["../src/BaseEngine.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAY,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AACtE,OAAO,EAAE,kCAAkC,EAAE,sBAAsB,EAA0C,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAC3K,OAAO,EAAE,mCAAmC,EAAE,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAGvF;;;GAGG;AACH,qBAAa,uBAAwB,SAAQ,UAAU,CAAC,uBAAuB,CAAC;IAC5E;;OAEG;IACH,WAAkB,QAAQ,IAAI,uBAAuB,CAEpD;IAEA,OAAO,CAAC,iBAAiB,CAAuC;IAChE,OAAO,CAAC,UAAU,CAAwC;IAC1D,OAAO,CAAC,qBAAqB,CAA2C;IAExE;;;;;OAKG;IACU,MAAM,CAAC,YAAY,GAAE,OAAe,EAAE,WAAW,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;cAmBhE,iBAAiB,CAAC,WAAW,CAAC,EAAE,QAAQ;IAOjE,IAAW,gBAAgB,IAAI,kCAAkC,EAAE,CAIlE;IACD,IAAW,SAAS,IAAI,mCAAmC,EAAE,CAI5D;IAGD;;OAEG;cACa,QAAQ,IAAI,OAAO,CAAC,sBAAsB,CAAC;IAc3D;;;;OAIG;cACa,MAAM,CAAC,GAAG,EAAE,sBAAsB,GAAG,OAAO,CAAC,OAAO,CAAC;IAMrE;;;;OAIG;cACa,QAAQ,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,GAAG,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,sBAAsB,CAAC;CAsB/H"}

package/dist/BaseEngine.js

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommunicationEngineBase = void 0;
+const core_1 = require("@memberjunction/core");
+/**
+ * Base class for communications. This class can be sub-classed if desired if you would like to modify the logic across ALL actions. To do so, sub-class this class and use the
+ * @RegisterClass decorator from the @memberjunction/global package to register your sub-class with the ClassFactory. This will cause your sub-class to be used instead of this base class when the Metadata object insantiates the ActionEngine.
+ */
+class CommunicationEngineBase extends core_1.BaseEngine {
+    /**
+     * Returns the global instance of the class. This is a singleton class, so there is only one instance of it in the application. Do not directly create new instances of it, always use this method to get the instance.
+     */
+    static get Instance() {
+        return super.getInstance();
+    }
+    /**
+     * This method is called to configure the engine. It loads the metadata and caches it in the GlobalObjectStore. You must call this method before doing anything else with the engine.
+     * If this method was previously run on the instance of the engine, it will return immediately without re-loading the metadata. If you want to force a reload of the metadata, you can pass true for the forceReload parameter.
+     * @param forceRefresh If true, the metadata will be loaded from the database even if it was previously loaded.
+     * @param contextUser If you are running on the server side you must pass this in, but it is not required in an environment where a user is authenticated directly, e.g. a browser or other client.
+     */
+    async Config(forceRefresh = false, contextUser) {
+        const config = [
+            {
+                EntityName: 'Communication Base Message Types',
+                PropertyName: '_BaseMessageTypes'
+            },
+            {
+                EntityName: 'Communication Providers',
+                PropertyName: '_Providers'
+            },
+            {
+                EntityName: 'Communication Provider Message Types',
+                PropertyName: '_ProviderMessageTypes'
+            }
+        ];
+        await this.Load(config, forceRefresh, contextUser);
+    }
+    async AdditionalLoading(contextUser) {
+        // a little post-processing done within the context of the base classes loading architecture...
+        this._Providers.forEach((provider) => {
+            provider.MessageTypes = this._ProviderMessageTypes.filter((pmt) => pmt.CommunicationProviderID === provider.ID);
+        });
+    }
+    get BaseMessageTypes() {
+        if (!this.Loaded)
+            throw new Error(`Metadata not loaded. Call Config() before accessing metadata.`);
+        return this._BaseMessageTypes;
+    }
+    get Providers() {
+        if (!this.Loaded)
+            throw new Error(`Metadata not loaded. Call Config() before accessing metadata.`);
+        return this._Providers;
+    }
+    /**
+     * Starts a communication run
+     */
+    async StartRun() {
+        const md = new core_1.Metadata();
+        const run = await md.GetEntityObject('Communication Runs', this.ContextUser);
+        run.Status = 'Pending';
+        run.Direction = 'Sending';
+        run.StartedAt = new Date();
+        run.UserID = this.ContextUser.ID;
+        if (await run.Save()) {
+            return run;
+        }
+        else
+            return null;
+    }
+    /**
+     * Ends a communication run
+     * @param run
+     * @returns
+     */
+    async EndRun(run) {
+        run.Status = 'Complete';
+        run.EndedAt = new Date();
+        return await run.Save();
+    }
+    /**
+     * This method creates a new Communication Log record and saves it to the database with a status of pending. It returns the new Communication Log record.
+     * @param processedMessage
+     * @param run
+     */
+    async StartLog(processedMessage, run) {
+        const md = new core_1.Metadata();
+        const log = await md.GetEntityObject('Communication Logs', this.ContextUser);
+        log.CommunicationRunID = run?.ID;
+        log.Status = 'Pending';
+        log.CommunicationProviderID = processedMessage.MessageType.CommunicationProviderID;
+        log.CommunicationProviderMessageTypeID = processedMessage.MessageType.ID;
+        log.MessageDate = new Date();
+        log.Direction = 'Sending';
+        log.MessageContent = JSON.stringify({
+            To: processedMessage.To,
+            From: processedMessage.From,
+            Subject: processedMessage.ProcessedSubject,
+            HTMLBody: processedMessage.ProcessedHTMLBody,
+            TextBody: processedMessage.ProcessedBody,
+        });
+        if (await log.Save()) {
+            return log;
+        }
+        else
+            return null;
+    }
+}
+exports.CommunicationEngineBase = CommunicationEngineBase;
+//# sourceMappingURL=BaseEngine.js.map

package/dist/BaseEngine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseEngine.js","sourceRoot":"","sources":["../src/BaseEngine.ts"],"names":[],"mappings":";;;AAAA,+CAAsE;AAKtE;;;GAGG;AACH,MAAa,uBAAwB,SAAQ,iBAAmC;IAC5E;;OAEG;IACI,MAAM,KAAK,QAAQ;QACvB,OAAO,KAAK,CAAC,WAAW,EAA2B,CAAC;IACvD,CAAC;IAMA;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,eAAwB,KAAK,EAAE,WAAsB;QACtE,MAAM,MAAM,GAAG;YACX;gBACI,UAAU,EAAE,kCAAkC;gBAC9C,YAAY,EAAE,mBAAmB;aACpC;YACD;gBACI,UAAU,EAAE,yBAAyB;gBACrC,YAAY,EAAE,YAAY;aAC7B;YACD;gBACI,UAAU,EAAE,sCAAsC;gBAClD,YAAY,EAAE,uBAAuB;aACxC;SAAC,CAAA;QAEN,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;IAEtD,CAAC;IAEkB,KAAK,CAAC,iBAAiB,CAAC,WAAsB;QAC9D,+FAA+F;QAC/F,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;YACjC,QAAQ,CAAC,YAAY,GAAG,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,uBAAuB,KAAK,QAAQ,CAAC,EAAE,CAAC,CAAC;QACpH,CAAC,CAAC,CAAC;IACN,CAAC;IAED,IAAW,gBAAgB;QACxB,IAAI,CAAC,IAAI,CAAC,MAAM;YACZ,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;QACrF,OAAO,IAAI,CAAC,iBAAiB,CAAC;IACjC,CAAC;IACD,IAAW,SAAS;QACjB,IAAI,CAAC,IAAI,CAAC,MAAM;YACZ,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;QACrF,OAAO,IAAI,CAAC,UAAU,CAAC;IAC1B,CAAC;IAGD;;OAEG;IACO,KAAK,CAAC,QAAQ;QACrB,MAAM,EAAE,GAAG,IAAI,eAAQ,EAAE,CAAC;QAC1B,MAAM,GAAG,GAAG,MAAM,EAAE,CAAC,eAAe,CAAyB,oBAAoB,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACrG,GAAG,CAAC,MAAM,GAAG,SAAS,CAAC;QACvB,GAAG,CAAC,SAAS,GAAG,SAAS,CAAC;QAC1B,GAAG,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;QAC3B,GAAG,CAAC,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;QACjC,IAAI,MAAM,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC;YACnB,OAAO,GAAG,CAAC;QACf,CAAC;;YAEG,OAAO,IAAI,CAAC;IACnB,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,MAAM,CAAC,GAA2B;QAC/C,GAAG,CAAC,MAAM,GAAG,UAAU,CAAC;QACxB,GAAG,CAAC,OAAO,GAAG,IAAI,IAAI,EAAE,CAAC;QACzB,OAAO,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,QAAQ,CAAC,gBAAkC,EAAE,GAA4B;QACtF,MAAM,EAAE,GAAG,IAAI,eAAQ,EAAE,CAAC;QAC1B,MAAM,GAAG,GAAG,MAAM,EAAE,CAAC,eAAe,CAAyB,oBAAoB,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACrG,GAAG,CAAC,kBAAkB,GAAG,GAAG,EAAE,EAAE,CAAC;QACjC,GAAG,CAAC,MAAM,GAAG,SAAS,CAAC;QACvB,GAAG,CAAC,uBAAuB,GAAG,gBAAgB,CAAC,WAAW,CAAC,uBAAuB,CAAC;QACnF,GAAG,CAAC,kCAAkC,GAAG,gBAAgB,CAAC,WAAW,CAAC,EAAE,CAAC;QACzE,GAAG,CAAC,WAAW,GAAG,IAAI,IAAI,EAAE,CAAC;QAC7B,GAAG,CAAC,SAAS,GAAG,SAAS,CAAC;QAC1B,GAAG,CAAC,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC;YAChC,EAAE,EAAE,gBAAgB,CAAC,EAAE;YACvB,IAAI,EAAE,gBAAgB,CAAC,IAAI;YAC3B,OAAO,EAAE,gBAAgB,CAAC,gBAAgB;YAC1C,QAAQ,EAAE,gBAAgB,CAAC,iBAAiB;YAC5C,QAAQ,EAAE,gBAAgB,CAAC,aAAa;SAC3C,CAAC,CAAC;QACH,IAAI,MAAM,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC;YACnB,OAAO,GAAG,CAAC;QACf,CAAC;;YAEG,OAAO,IAAI,CAAC;IACnB,CAAC;CACL;AA/GD,0DA+GC"}

package/dist/BaseProvider.d.ts

@@ -0,0 +1,119 @@
+import { UserInfo } from "@memberjunction/core";
+import { CommunicationProviderEntity, CommunicationProviderMessageTypeEntity, CommunicationRunEntity } from "@memberjunction/core-entities";
+import { TemplateEntityExtended } from "@memberjunction/templates-base-types";
+/**
+ * Information about a single recipient
+ */
+export declare class MessageRecipient {
+    /**
+     * The address is the "TO" field for the message and would be either an email, phone #, social handle, etc
+     * it is provider-specific and can be anything that the provider supports as a recipient
+     */
+    To: string;
+    /**
+     * The full name of the recipient, if available
+     */
+    FullName?: string;
+    /**
+     * When using templates, this is the context data that is used to render the template for this recipient
+     */
+    ContextData: any;
+}
+/**
+ * Message class, holds information and functionality specific to a single message
+ */
+export declare class Message {
+    /**
+     * The type of message to send
+     */
+    MessageType: CommunicationProviderMessageTypeEntity;
+    /**
+     * The sender of the message, typically an email address but can be anything that is provider-specific for example for a provider that is a social
+     * media provider, it might be a user's social media handle
+     */
+    From: string;
+    /**
+     * The recipient of the message, typically an email address but can be anything that is provider-specific for example for a provider that is a social
+     * media provider, it might be a user's social media handle
+     */
+    To: string;
+    /**
+     * The body of the message, used if BodyTemplate is not provided.
+     */
+    Body?: string;
+    /**
+     * Optional, when provided, Body is ignored and the template is used to render the message. In addition,
+     * if BodyTemplate is provided it will be used to render the Body and if the template has HTML content it will
+     * also be used to render the HTMLBody
+     */
+    BodyTemplate?: TemplateEntityExtended;
+    /**
+     * The HTML body of the message
+     */
+    HTMLBody?: string;
+    /**
+     * Optional, when provided, HTMLBody is ignored and the template is used to render the message. This OVERRIDES
+     * the BodyTemplate's HTML content even if BodyTemplate is provided. This allows for flexibility in that you can
+     * specify a completely different HTMLBodyTemplate and not just relay on the TemplateContent of the BodyTemplate having
+     * an HTML option.
+     */
+    HTMLBodyTemplate?: TemplateEntityExtended;
+    /**
+     * The subject line for the message, used if SubjectTemplate is not provided and only supported by some providers
+     */
+    Subject?: string;
+    /**
+     * Optional, when provided, Subject is ignored and the template is used to render the message
+     */
+    SubjectTemplate?: TemplateEntityExtended;
+    /**
+     * Optional, any context data that is needed to render the message template
+     */
+    ContextData?: any;
+    constructor(copyFrom?: Message);
+}
+/**
+ * This class is used to hold the results of a pre-processed message. This is used to hold the results of processing a message, for example, rendering a template.
+ */
+export declare abstract class ProcessedMessage extends Message {
+    /**
+     * The body of the message after processing
+     */
+    ProcessedBody: string;
+    /**
+     * The HTML body of the message after processing
+     */
+    ProcessedHTMLBody: string;
+    /**
+     * The subject of the message after processing
+     */
+    ProcessedSubject: string;
+    abstract Process(forceTemplateRefresh?: boolean, contextUser?: UserInfo): Promise<{
+        Success: boolean;
+        Message?: string;
+    }>;
+}
+/**
+ * MessageResult class, holds information and functionality specific to a single message result
+ */
+export declare class MessageResult {
+    Run?: CommunicationRunEntity;
+    Message: ProcessedMessage;
+    Success: boolean;
+    Error: string;
+}
+/**
+ * Base class for all communication providers. Each provider sub-classes this base class and implements functionality specific to the provider.
+ */
+export declare abstract class BaseCommunicationProvider {
+    /**
+     *
+     */
+    abstract SendSingleMessage(message: ProcessedMessage): Promise<MessageResult>;
+}
+export declare class CommunicationProviderEntityExtended extends CommunicationProviderEntity {
+    private _ProviderMessageTypes;
+    get MessageTypes(): CommunicationProviderMessageTypeEntity[];
+    set MessageTypes(value: CommunicationProviderMessageTypeEntity[]);
+}
+//# sourceMappingURL=BaseProvider.d.ts.map

package/dist/BaseProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseProvider.d.ts","sourceRoot":"","sources":["../src/BaseProvider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAE5D,OAAO,EAAE,2BAA2B,EAAE,sCAAsC,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAC5I,OAAO,EAAE,sBAAsB,EAAE,MAAM,sCAAsC,CAAC;AAE9E;;GAEG;AACH,qBAAa,gBAAgB;IACzB;;;OAGG;IACI,EAAE,EAAE,MAAM,CAAC;IAClB;;OAEG;IACI,QAAQ,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACI,WAAW,EAAE,GAAG,CAAC;CAC3B;AAGD;;GAEG;AACH,qBAAa,OAAO;IAChB;;OAEG;IACI,WAAW,EAAE,sCAAsC,CAAC;IAE3D;;;OAGG;IACI,IAAI,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACI,EAAE,EAAE,MAAM,CAAC;IAElB;;OAEG;IACI,IAAI,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACI,YAAY,CAAC,EAAE,sBAAsB,CAAC;IAE7C;;OAEG;IACI,QAAQ,CAAC,EAAE,MAAM,CAAC;IACzB;;;;;OAKG;IACI,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;IAEjD;;OAEG;IACI,OAAO,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACI,eAAe,CAAC,EAAE,sBAAsB,CAAC;IAEhD;;OAEG;IACI,WAAW,CAAC,EAAE,GAAG,CAAC;gBAEb,QAAQ,CAAC,EAAE,OAAO;CAKjC;AAED;;GAEG;AACH,8BAAsB,gBAAiB,SAAQ,OAAO;IAClD;;OAEG;IACI,aAAa,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACI,iBAAiB,EAAE,MAAM,CAAA;IAEhC;;OAEG;IACI,gBAAgB,EAAE,MAAM,CAAC;aAGhB,OAAO,CAAC,oBAAoB,CAAC,EAAE,OAAO,EAAE,WAAW,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC;QAAC,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAC,CAAC;CACjI;AAED;;GAEG;AACH,qBAAa,aAAa;IACf,GAAG,CAAC,EAAE,sBAAsB,CAAC;IAC7B,OAAO,EAAE,gBAAgB,CAAC;IAC1B,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,8BAAsB,yBAAyB;IAC3C;;OAEG;aACa,iBAAiB,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,aAAa,CAAC;CACvF;AAED,qBACa,mCAAoC,SAAQ,2BAA2B;IAChF,OAAO,CAAC,qBAAqB,CAA2C;IACxE,IAAW,YAAY,IAAI,sCAAsC,EAAE,CAElE;IACD,IAAW,YAAY,CAAC,KAAK,EAAE,sCAAsC,EAAE,EAEtE;CACJ"}

package/dist/BaseProvider.js

@@ -0,0 +1,60 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommunicationProviderEntityExtended = exports.BaseCommunicationProvider = exports.MessageResult = exports.ProcessedMessage = exports.Message = exports.MessageRecipient = void 0;
+const core_1 = require("@memberjunction/core");
+const global_1 = require("@memberjunction/global");
+const core_entities_1 = require("@memberjunction/core-entities");
+/**
+ * Information about a single recipient
+ */
+class MessageRecipient {
+}
+exports.MessageRecipient = MessageRecipient;
+/**
+ * Message class, holds information and functionality specific to a single message
+ */
+class Message {
+    constructor(copyFrom) {
+        // copy all properties from the message to us, used for copying a message
+        if (copyFrom)
+            Object.assign(this, copyFrom);
+    }
+}
+exports.Message = Message;
+/**
+ * This class is used to hold the results of a pre-processed message. This is used to hold the results of processing a message, for example, rendering a template.
+ */
+class ProcessedMessage extends Message {
+}
+exports.ProcessedMessage = ProcessedMessage;
+/**
+ * MessageResult class, holds information and functionality specific to a single message result
+ */
+class MessageResult {
+}
+exports.MessageResult = MessageResult;
+/**
+ * Base class for all communication providers. Each provider sub-classes this base class and implements functionality specific to the provider.
+ */
+class BaseCommunicationProvider {
+}
+exports.BaseCommunicationProvider = BaseCommunicationProvider;
+let CommunicationProviderEntityExtended = class CommunicationProviderEntityExtended extends core_entities_1.CommunicationProviderEntity {
+    get MessageTypes() {
+        return this._ProviderMessageTypes;
+    }
+    set MessageTypes(value) {
+        this._ProviderMessageTypes = value;
+    }
+};
+exports.CommunicationProviderEntityExtended = CommunicationProviderEntityExtended;
+exports.CommunicationProviderEntityExtended = CommunicationProviderEntityExtended = __decorate([
+    (0, global_1.RegisterClass)(core_1.BaseEntity, 'Communication Providers') // sub-class to extend the properties of the base entity
+], CommunicationProviderEntityExtended);
+//# sourceMappingURL=BaseProvider.js.map

package/dist/BaseProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseProvider.js","sourceRoot":"","sources":["../src/BaseProvider.ts"],"names":[],"mappings":";;;;;;;;;AAAA,+CAA4D;AAC5D,mDAAuD;AACvD,iEAA4I;AAG5I;;GAEG;AACH,MAAa,gBAAgB;CAe5B;AAfD,4CAeC;AAGD;;GAEG;AACH,MAAa,OAAO;IAuDhB,YAAY,QAAkB;QAC1B,yEAAyE;QACzE,IAAI,QAAQ;YACR,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACtC,CAAC;CACJ;AA5DD,0BA4DC;AAED;;GAEG;AACH,MAAsB,gBAAiB,SAAQ,OAAO;CAkBrD;AAlBD,4CAkBC;AAED;;GAEG;AACH,MAAa,aAAa;CAKzB;AALD,sCAKC;AAED;;GAEG;AACH,MAAsB,yBAAyB;CAK9C;AALD,8DAKC;AAGM,IAAM,mCAAmC,GAAzC,MAAM,mCAAoC,SAAQ,2CAA2B;IAEhF,IAAW,YAAY;QACnB,OAAO,IAAI,CAAC,qBAAqB,CAAC;IACtC,CAAC;IACD,IAAW,YAAY,CAAC,KAA+C;QACnE,IAAI,CAAC,qBAAqB,GAAG,KAAK,CAAC;IACvC,CAAC;CACJ,CAAA;AARY,kFAAmC;8CAAnC,mCAAmC;IAD/C,IAAA,sBAAa,EAAC,iBAAU,EAAE,yBAAyB,CAAC,CAAC,wDAAwD;GACjG,mCAAmC,CAQ/C"}

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from './BaseEngine';
+export * from './BaseProvider';
+//# 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,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC"}

package/dist/index.js

@@ -0,0 +1,20 @@
+"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("./BaseEngine"), exports);
+__exportStar(require("./BaseProvider"), 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,+CAA6B;AAC7B,iDAA+B"}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@memberjunction/communication-types",
+  "version": "1.5.3",
+  "description": "MemberJunction: Communication Framework Library Generic Types",
+  "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/templates-base-types": "1.5.3",
+    "@memberjunction/core-entities": "1.5.3",
+    "rxjs": "^7.8.1"
+  }
+}