@memberjunction/entity-communications-base 1.5.3

package/dist/base.d.ts

@@ -0,0 +1,39 @@
+import { BaseEngine, RunViewParams, UserInfo } from "@memberjunction/core";
+import { EntityCommunicationFieldEntity, EntityCommunicationMessageTypeEntity } from "@memberjunction/core-entities";
+import { Message } from '@memberjunction/communication-types';
+export declare class EntityCommunicationMessageTypeExtended extends EntityCommunicationMessageTypeEntity {
+    CommunicationFields: EntityCommunicationFieldEntity[];
+}
+export declare abstract class EntityCommunicationsEngineBase extends BaseEngine<EntityCommunicationsEngineBase> {
+    Config(forceRefresh?: boolean, contextUser?: UserInfo): Promise<void>;
+    static get Instance(): EntityCommunicationsEngineBase;
+    private _EntityCommunicationMessageTypes;
+    private _EntityCommunicationFields;
+    get EntityCommunicationMessageTypes(): EntityCommunicationMessageTypeExtended[];
+    get EntityCommunicationFields(): EntityCommunicationFieldEntity[];
+    protected AdditionalLoading(contextUser?: UserInfo): Promise<void>;
+    /**
+     * Returns a list of communication message types for the given entity
+     * @param entityID
+     * @returns
+     */
+    GetEntityCommunicationMessageTypes(entityID: number): EntityCommunicationMessageTypeExtended[];
+    /**
+     * Returns true if the specified entity has any communication message types
+     * @param entityID
+     */
+    EntitySupportsCommunication(entityID: number): 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
+     */
+    abstract RunEntityCommunication(entityID: number, runViewParams: RunViewParams, providerName: string, providerMessageTypeName: string, message: Message): Promise<{
+        Success: boolean;
+        ErrorMessage: string;
+    }>;
+}
+//# sourceMappingURL=base.d.ts.map

package/dist/base.d.ts.map

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

package/dist/base.js

@@ -0,0 +1,76 @@
+"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.EntityCommunicationsEngineBase = exports.EntityCommunicationMessageTypeExtended = void 0;
+const core_1 = require("@memberjunction/core");
+const core_entities_1 = require("@memberjunction/core-entities");
+const global_1 = require("@memberjunction/global");
+let EntityCommunicationMessageTypeExtended = class EntityCommunicationMessageTypeExtended extends core_entities_1.EntityCommunicationMessageTypeEntity {
+    constructor() {
+        super(...arguments);
+        this.CommunicationFields = [];
+    }
+};
+exports.EntityCommunicationMessageTypeExtended = EntityCommunicationMessageTypeExtended;
+exports.EntityCommunicationMessageTypeExtended = EntityCommunicationMessageTypeExtended = __decorate([
+    (0, global_1.RegisterClass)(core_1.BaseEntity, 'Entity Communication Message Types')
+], EntityCommunicationMessageTypeExtended);
+class EntityCommunicationsEngineBase extends core_1.BaseEngine {
+    constructor() {
+        super(...arguments);
+        this._EntityCommunicationMessageTypes = [];
+        this._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);
+    }
+    static get Instance() {
+        return super.getInstance();
+    }
+    get EntityCommunicationMessageTypes() {
+        return this._EntityCommunicationMessageTypes;
+    }
+    get EntityCommunicationFields() {
+        return this._EntityCommunicationFields;
+    }
+    async AdditionalLoading(contextUser) {
+        // post-process the fields to be linked to the message types they're part of 
+        this.EntityCommunicationMessageTypes.forEach(m => {
+            m.CommunicationFields = this.EntityCommunicationFields.filter(f => f.EntityCommunicationMessageTypeID === m.ID);
+        });
+    }
+    /**
+     * Returns a list of communication message types for the given entity
+     * @param entityID
+     * @returns
+     */
+    GetEntityCommunicationMessageTypes(entityID) {
+        this.TryThrowIfNotLoaded();
+        return this.EntityCommunicationMessageTypes.filter(m => m.EntityID === entityID);
+    }
+    /**
+     * Returns true if the specified entity has any communication message types
+     * @param entityID
+     */
+    EntitySupportsCommunication(entityID) {
+        this.TryThrowIfNotLoaded();
+        return this.GetEntityCommunicationMessageTypes(entityID).length > 0;
+    }
+}
+exports.EntityCommunicationsEngineBase = EntityCommunicationsEngineBase;
+//# sourceMappingURL=base.js.map

package/dist/base.js.map

@@ -0,0 +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,GAA+B;YAClC;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"}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './base';
+//# 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,QAAQ,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("./base"), 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,yCAAuB"}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@memberjunction/entity-communications-base",
+  "version": "1.5.3",
+  "description": "MemberJunction: Base Types for Client/Server use with Entity Communications 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/communication-types": "1.5.3"
+  }
+}