@memberjunction/entity-communications-base 1.8.1 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/base.d.ts +23 -12
  2. package/dist/base.d.ts.map +1 -1
  3. package/dist/base.js +14 -1
  4. package/dist/base.js.map +1 -1
  5. package/package.json +5 -5
package/dist/base.d.ts CHANGED
@@ -1,9 +1,27 @@
1
1
  import { BaseEngine, RunViewParams, UserInfo } from "@memberjunction/core";
2
2
  import { EntityCommunicationFieldEntity, EntityCommunicationMessageTypeEntity } from "@memberjunction/core-entities";
3
- import { Message } from '@memberjunction/communication-types';
3
+ import { Message, ProcessedMessage } from '@memberjunction/communication-types';
4
4
  export declare class EntityCommunicationMessageTypeExtended extends EntityCommunicationMessageTypeEntity {
5
5
  CommunicationFields: EntityCommunicationFieldEntity[];
6
6
  }
7
+ export declare class EntityCommunicationParams {
8
+ EntityID: string;
9
+ RunViewParams: RunViewParams;
10
+ ProviderName: string;
11
+ ProviderMessageTypeName: string;
12
+ Message: Message;
13
+ PreviewOnly?: boolean;
14
+ IncludeProcessedMessages?: boolean;
15
+ }
16
+ export declare class EntityCommunicationResultItem {
17
+ RecipientData: any;
18
+ Message: ProcessedMessage;
19
+ }
20
+ export declare class EntityCommunicationResult {
21
+ Success: boolean;
22
+ ErrorMessage?: string;
23
+ Results?: EntityCommunicationResultItem[];
24
+ }
7
25
  export declare abstract class EntityCommunicationsEngineBase extends BaseEngine<EntityCommunicationsEngineBase> {
8
26
  Config(forceRefresh?: boolean, contextUser?: UserInfo): Promise<void>;
9
27
  static get Instance(): EntityCommunicationsEngineBase;
@@ -17,23 +35,16 @@ export declare abstract class EntityCommunicationsEngineBase extends BaseEngine<
17
35
  * @param entityID
18
36
  * @returns
19
37
  */
20
- GetEntityCommunicationMessageTypes(entityID: number): EntityCommunicationMessageTypeExtended[];
38
+ GetEntityCommunicationMessageTypes(entityID: string): EntityCommunicationMessageTypeExtended[];
21
39
  /**
22
40
  * Returns true if the specified entity has any communication message types
23
41
  * @param entityID
24
42
  */
25
- EntitySupportsCommunication(entityID: number): boolean;
43
+ EntitySupportsCommunication(entityID: string): boolean;
26
44
  /**
27
45
  * Executes a given message request against a view of records for a given entity
28
- * @param entityID
29
- * @param runViewParams
30
- * @param providerName
31
- * @param providerMessageTypeName
32
- * @param message
46
+ * @param params
33
47
  */
34
- abstract RunEntityCommunication(entityID: number, runViewParams: RunViewParams, providerName: string, providerMessageTypeName: string, message: Message): Promise<{
35
- Success: boolean;
36
- ErrorMessage: string;
37
- }>;
48
+ abstract RunEntityCommunication(params: EntityCommunicationParams): Promise<EntityCommunicationResult>;
38
49
  }
39
50
  //# sourceMappingURL=base.d.ts.map
package/dist/base.d.ts.map CHANGED
@@ -1 +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"}
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,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AAEhF,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;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;;;OAGG;aACa,sBAAsB,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,yBAAyB,CAAC;CAEhH"}
package/dist/base.js CHANGED
@@ -6,7 +6,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
6
6
  return c > 3 && r && Object.defineProperty(target, key, r), r;
7
7
  };
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
- exports.EntityCommunicationsEngineBase = exports.EntityCommunicationMessageTypeExtended = void 0;
9
+ exports.EntityCommunicationsEngineBase = exports.EntityCommunicationResult = exports.EntityCommunicationResultItem = exports.EntityCommunicationParams = exports.EntityCommunicationMessageTypeExtended = void 0;
10
10
  const core_1 = require("@memberjunction/core");
11
11
  const core_entities_1 = require("@memberjunction/core-entities");
12
12
  const global_1 = require("@memberjunction/global");
@@ -20,6 +20,19 @@ exports.EntityCommunicationMessageTypeExtended = EntityCommunicationMessageTypeE
20
20
  exports.EntityCommunicationMessageTypeExtended = EntityCommunicationMessageTypeExtended = __decorate([
21
21
  (0, global_1.RegisterClass)(core_1.BaseEntity, 'Entity Communication Message Types')
22
22
  ], EntityCommunicationMessageTypeExtended);
23
+ class EntityCommunicationParams {
24
+ constructor() {
25
+ this.PreviewOnly = false;
26
+ this.IncludeProcessedMessages = false;
27
+ }
28
+ }
29
+ exports.EntityCommunicationParams = EntityCommunicationParams;
30
+ class EntityCommunicationResultItem {
31
+ }
32
+ exports.EntityCommunicationResultItem = EntityCommunicationResultItem;
33
+ class EntityCommunicationResult {
34
+ }
35
+ exports.EntityCommunicationResult = EntityCommunicationResult;
23
36
  class EntityCommunicationsEngineBase extends core_1.BaseEngine {
24
37
  constructor() {
25
38
  super(...arguments);
package/dist/base.js.map CHANGED
@@ -1 +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"}
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;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;;QAmBY,qCAAgC,GAA6C,EAAE,CAAC;QAChF,+BAA0B,GAAqC,EAAE,CAAC;IAgD9E,CAAC;IAnEU,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;CAgBJ;AApED,wEAoEC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@memberjunction/entity-communications-base",
3
- "version": "1.8.1",
3
+ "version": "2.0.0",
4
4
  "description": "MemberJunction: Base Types for Client/Server use with Entity Communications Engine",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -19,9 +19,9 @@
19
19
  "typescript": "^5.4.5"
20
20
  },
21
21
  "dependencies": {
22
- "@memberjunction/global": "1.8.1",
23
- "@memberjunction/core": "1.8.1",
24
- "@memberjunction/core-entities": "1.8.1",
25
- "@memberjunction/communication-types": "1.8.1"
22
+ "@memberjunction/global": "2.0.0",
23
+ "@memberjunction/core": "2.0.0",
24
+ "@memberjunction/core-entities": "2.0.0",
25
+ "@memberjunction/communication-types": "2.0.0"
26
26
  }
27
27
  }