@memberjunction/communication-engine 1.8.0 → 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.
package/dist/Engine.d.ts CHANGED
@@ -19,10 +19,10 @@ export declare class CommunicationEngine extends CommunicationEngineBase {
19
19
  * @param providerMessageTypeName
20
20
  * @param message this will be used as a starting point but the To will be replaced with the recipient in the recipients array
21
21
  */
22
- SendMessages(providerName: string, providerMessageTypeName: string, message: Message, recipients: MessageRecipient[]): Promise<MessageResult[]>;
22
+ SendMessages(providerName: string, providerMessageTypeName: string, message: Message, recipients: MessageRecipient[], previewOnly?: boolean): Promise<MessageResult[]>;
23
23
  /**
24
24
  * Sends a single message using the specified provider. The provider must be one of the providers that are configured in the system.
25
25
  */
26
- SendSingleMessage(providerName: string, providerMessageTypeName: string, message: Message, run?: CommunicationRunEntity): Promise<MessageResult>;
26
+ SendSingleMessage(providerName: string, providerMessageTypeName: string, message: Message, run?: CommunicationRunEntity, previewOnly?: boolean): Promise<MessageResult>;
27
27
  }
28
28
  //# sourceMappingURL=Engine.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"Engine.d.ts","sourceRoot":"","sources":["../src/Engine.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AACnJ,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAKvE;;;GAGG;AACH,qBAAa,mBAAoB,SAAQ,uBAAuB;IAC5D,WAAkB,QAAQ,IAAI,mBAAmB,CAEhD;IAEA;;;;OAIG;IACI,WAAW,CAAC,YAAY,EAAE,MAAM,GAAG,yBAAyB;IAkBnE;;;;;;OAMG;IACU,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,uBAAuB,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAoB5J;;OAEG;IACU,iBAAiB,CAAC,YAAY,EAAE,MAAM,EAAE,uBAAuB,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,aAAa,CAAC;CAwCjK"}
1
+ {"version":3,"file":"Engine.d.ts","sourceRoot":"","sources":["../src/Engine.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,uBAAuB,EAAE,OAAO,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AACnJ,OAAO,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAKvE;;;GAGG;AACH,qBAAa,mBAAoB,SAAQ,uBAAuB;IAC5D,WAAkB,QAAQ,IAAI,mBAAmB,CAEhD;IAEA;;;;OAIG;IACI,WAAW,CAAC,YAAY,EAAE,MAAM,GAAG,yBAAyB;IAkBnE;;;;;;OAMG;IACU,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,uBAAuB,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,EAAE,WAAW,GAAE,OAAe,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAoB1L;;OAEG;IACU,iBAAiB,CAAC,YAAY,EAAE,MAAM,EAAE,uBAAuB,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,sBAAsB,EAAE,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,aAAa,CAAC;CA6CxL"}
package/dist/Engine.js CHANGED
@@ -39,7 +39,7 @@ class CommunicationEngine extends communication_types_1.CommunicationEngineBase
39
39
  * @param providerMessageTypeName
40
40
  * @param message this will be used as a starting point but the To will be replaced with the recipient in the recipients array
41
41
  */
42
- async SendMessages(providerName, providerMessageTypeName, message, recipients) {
42
+ async SendMessages(providerName, providerMessageTypeName, message, recipients, previewOnly = false) {
43
43
  const run = await this.StartRun();
44
44
  if (!run)
45
45
  throw new Error(`Failed to start communication run.`);
@@ -48,7 +48,7 @@ class CommunicationEngine extends communication_types_1.CommunicationEngineBase
48
48
  const messageCopy = new communication_types_1.Message(message);
49
49
  messageCopy.To = r.To;
50
50
  messageCopy.ContextData = r.ContextData;
51
- const result = await this.SendSingleMessage(providerName, providerMessageTypeName, messageCopy, run);
51
+ const result = await this.SendSingleMessage(providerName, providerMessageTypeName, messageCopy, run, previewOnly);
52
52
  results.push(result);
53
53
  }
54
54
  if (!await this.EndRun(run))
@@ -58,7 +58,7 @@ class CommunicationEngine extends communication_types_1.CommunicationEngineBase
58
58
  /**
59
59
  * Sends a single message using the specified provider. The provider must be one of the providers that are configured in the system.
60
60
  */
61
- async SendSingleMessage(providerName, providerMessageTypeName, message, run) {
61
+ async SendSingleMessage(providerName, providerMessageTypeName, message, run, previewOnly) {
62
62
  if (!this.Loaded)
63
63
  throw new Error(`Metadata not loaded. Call Config() before accessing metadata.`);
64
64
  const provider = this.GetProvider(providerName);
@@ -78,21 +78,26 @@ class CommunicationEngine extends communication_types_1.CommunicationEngineBase
78
78
  const processedMessage = new BaseProvider_1.ProcessedMessageServer(message);
79
79
  const processResult = await processedMessage.Process(false, this.ContextUser);
80
80
  if (processResult.Success) {
81
- const log = await this.StartLog(processedMessage, run);
82
- if (log) {
83
- const sendResult = await provider.SendSingleMessage(processedMessage);
84
- log.Status = sendResult.Success ? 'Complete' : 'Failed';
85
- log.ErrorMessage = sendResult.Error;
86
- if (!await log.Save())
87
- throw new Error(`Failed to complete log for message.`);
81
+ if (previewOnly) {
82
+ return { Success: true, Error: '', Message: processedMessage };
83
+ }
84
+ else {
85
+ const log = await this.StartLog(processedMessage, run);
86
+ if (log) {
87
+ const sendResult = await provider.SendSingleMessage(processedMessage);
88
+ log.Status = sendResult.Success ? 'Complete' : 'Failed';
89
+ log.ErrorMessage = sendResult.Error;
90
+ if (!await log.Save())
91
+ throw new Error(`Failed to complete log for message.`);
92
+ else
93
+ return sendResult;
94
+ }
88
95
  else
89
- return sendResult;
96
+ throw new Error(`Failed to start log for message.`);
90
97
  }
91
- else
92
- throw new Error(`Failed to start log for message.`);
93
98
  }
94
99
  else
95
- throw new Error(`Failed to process message.`);
100
+ throw new Error(`Failed to process message: ${processResult.Message}`);
96
101
  }
97
102
  }
98
103
  exports.CommunicationEngine = CommunicationEngine;
@@ -1 +1 @@
1
- {"version":3,"file":"Engine.js","sourceRoot":"","sources":["../src/Engine.ts"],"names":[],"mappings":";;;AAAA,6EAAmJ;AAEnJ,mDAAkD;AAClD,iDAAwD;AAGxD;;;GAGG;AACH,MAAa,mBAAoB,SAAQ,6CAAuB;IACrD,MAAM,KAAK,QAAQ;QACtB,OAAO,KAAK,CAAC,WAAW,EAAuB,CAAC;IACpD,CAAC;IAEA;;;;OAIG;IACI,WAAW,CAAC,YAAoB;QACpC,IAAI,CAAC,IAAI,CAAC,MAAM;YACZ,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;QAErF,MAAM,QAAQ,GAAG,iBAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,cAAc,CAA4B,+CAAyB,EAAE,YAAY,CAAC,CAAC;QACnI,IAAI,QAAQ,EAAE,CAAC;YACX,8HAA8H;YAC9H,4DAA4D;YAC5D,IAAI,QAAQ,CAAC,WAAW,CAAC,IAAI,KAAK,2BAA2B;gBACzD,MAAM,IAAI,KAAK,CAAC,YAAY,YAAY,aAAa,CAAC,CAAC;;gBAEvD,OAAO,QAAQ,CAAC,CAAC,+DAA+D;QACxF,CAAC;;YAEG,MAAM,IAAI,KAAK,CAAC,YAAY,YAAY,aAAa,CAAC,CAAC;IAC9D,CAAC;IAGD;;;;;;OAMG;IACI,KAAK,CAAC,YAAY,CAAC,YAAoB,EAAE,uBAA+B,EAAE,OAAgB,EAAE,UAA8B;QAC9H,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClC,IAAI,CAAC,GAAG;YACJ,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QAE1D,MAAM,OAAO,GAAoB,EAAE,CAAC;QACpC,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;YACzB,MAAM,WAAW,GAAG,IAAI,6BAAO,CAAC,OAAO,CAAC,CAAC;YACzC,WAAW,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;YACtB,WAAW,CAAC,WAAW,GAAG,CAAC,CAAC,WAAW,CAAC;YACxC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,uBAAuB,EAAE,WAAW,EAAE,GAAG,CAAC,CAAC;YACrG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzB,CAAC;QAED,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;QAExD,OAAO,OAAO,CAAC;IAClB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,iBAAiB,CAAC,YAAoB,EAAE,uBAA+B,EAAE,OAAgB,EAAE,GAA4B;QACjI,IAAI,CAAC,IAAI,CAAC,MAAM;YACZ,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;QAErF,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QAChD,IAAI,CAAC,QAAQ;YACT,MAAM,IAAI,KAAK,CAAC,YAAY,YAAY,aAAa,CAAC,CAAC;QAE3D,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC;QAC3E,IAAI,CAAC,cAAc;YACf,MAAM,IAAI,KAAK,CAAC,YAAY,YAAY,aAAa,CAAC,CAAC;QAE3D,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;YACvB,wBAAwB;YACxB,MAAM,mBAAmB,GAAG,cAAc,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,KAAK,uBAAuB,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YACtJ,IAAI,CAAC,mBAAmB;gBACpB,MAAM,IAAI,KAAK,CAAC,yBAAyB,uBAAuB,aAAa,CAAC,CAAC;YACnF,OAAO,CAAC,WAAW,GAAG,mBAAmB,CAAC;QAC9C,CAAC;QAED,2BAA2B;QAC3B,MAAM,gBAAgB,GAAG,IAAI,qCAAsB,CAAC,OAAO,CAAC,CAAC;QAC7D,MAAM,aAAa,GAAG,MAAM,gBAAgB,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC9E,IAAI,aAAa,CAAC,OAAO,EAAE,CAAC;YACxB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;YACvD,IAAI,GAAG,EAAE,CAAC;gBACN,MAAM,UAAU,GAAG,MAAM,QAAQ,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,CAAC;gBACtE,GAAG,CAAC,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC;gBACxD,GAAG,CAAC,YAAY,GAAG,UAAU,CAAC,KAAK,CAAC;gBACpC,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE;oBACjB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;;oBAEvD,OAAO,UAAU,CAAC;YAC1B,CAAC;;gBAEG,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;QAC5D,CAAC;;YAEG,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;IACrD,CAAC;CACL;AAlGD,kDAkGC"}
1
+ {"version":3,"file":"Engine.js","sourceRoot":"","sources":["../src/Engine.ts"],"names":[],"mappings":";;;AAAA,6EAAmJ;AAEnJ,mDAAkD;AAClD,iDAAwD;AAGxD;;;GAGG;AACH,MAAa,mBAAoB,SAAQ,6CAAuB;IACrD,MAAM,KAAK,QAAQ;QACtB,OAAO,KAAK,CAAC,WAAW,EAAuB,CAAC;IACpD,CAAC;IAEA;;;;OAIG;IACI,WAAW,CAAC,YAAoB;QACpC,IAAI,CAAC,IAAI,CAAC,MAAM;YACZ,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;QAErF,MAAM,QAAQ,GAAG,iBAAQ,CAAC,QAAQ,CAAC,YAAY,CAAC,cAAc,CAA4B,+CAAyB,EAAE,YAAY,CAAC,CAAC;QACnI,IAAI,QAAQ,EAAE,CAAC;YACX,8HAA8H;YAC9H,4DAA4D;YAC5D,IAAI,QAAQ,CAAC,WAAW,CAAC,IAAI,KAAK,2BAA2B;gBACzD,MAAM,IAAI,KAAK,CAAC,YAAY,YAAY,aAAa,CAAC,CAAC;;gBAEvD,OAAO,QAAQ,CAAC,CAAC,+DAA+D;QACxF,CAAC;;YAEG,MAAM,IAAI,KAAK,CAAC,YAAY,YAAY,aAAa,CAAC,CAAC;IAC9D,CAAC;IAGD;;;;;;OAMG;IACI,KAAK,CAAC,YAAY,CAAC,YAAoB,EAAE,uBAA+B,EAAE,OAAgB,EAAE,UAA8B,EAAE,cAAuB,KAAK;QAC5J,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClC,IAAI,CAAC,GAAG;YACJ,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QAE1D,MAAM,OAAO,GAAoB,EAAE,CAAC;QACpC,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;YACzB,MAAM,WAAW,GAAG,IAAI,6BAAO,CAAC,OAAO,CAAC,CAAC;YACzC,WAAW,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,CAAC;YACtB,WAAW,CAAC,WAAW,GAAG,CAAC,CAAC,WAAW,CAAC;YACxC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,uBAAuB,EAAE,WAAW,EAAE,GAAG,EAAE,WAAW,CAAC,CAAC;YAClH,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzB,CAAC;QAED,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;QAExD,OAAO,OAAO,CAAC;IAClB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,iBAAiB,CAAC,YAAoB,EAAE,uBAA+B,EAAE,OAAgB,EAAE,GAA4B,EAAE,WAAqB;QACxJ,IAAI,CAAC,IAAI,CAAC,MAAM;YACZ,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;QAErF,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QAChD,IAAI,CAAC,QAAQ;YACT,MAAM,IAAI,KAAK,CAAC,YAAY,YAAY,aAAa,CAAC,CAAC;QAE3D,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC;QAC3E,IAAI,CAAC,cAAc;YACf,MAAM,IAAI,KAAK,CAAC,YAAY,YAAY,aAAa,CAAC,CAAC;QAE3D,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;YACvB,wBAAwB;YACxB,MAAM,mBAAmB,GAAG,cAAc,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,KAAK,uBAAuB,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;YACtJ,IAAI,CAAC,mBAAmB;gBACpB,MAAM,IAAI,KAAK,CAAC,yBAAyB,uBAAuB,aAAa,CAAC,CAAC;YACnF,OAAO,CAAC,WAAW,GAAG,mBAAmB,CAAC;QAC9C,CAAC;QAED,2BAA2B;QAC3B,MAAM,gBAAgB,GAAG,IAAI,qCAAsB,CAAC,OAAO,CAAC,CAAC;QAC7D,MAAM,aAAa,GAAG,MAAM,gBAAgB,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC9E,IAAI,aAAa,CAAC,OAAO,EAAE,CAAC;YACxB,IAAI,WAAW,EAAE,CAAC;gBACd,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,gBAAgB,EAAE,CAAC;YACnE,CAAC;iBACI,CAAC;gBACF,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,gBAAgB,EAAE,GAAG,CAAC,CAAC;gBACvD,IAAI,GAAG,EAAE,CAAC;oBACN,MAAM,UAAU,GAAG,MAAM,QAAQ,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,CAAC;oBACtE,GAAG,CAAC,MAAM,GAAG,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC;oBACxD,GAAG,CAAC,YAAY,GAAG,UAAU,CAAC,KAAK,CAAC;oBACpC,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE;wBACjB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;;wBAEvD,OAAO,UAAU,CAAC;gBAC1B,CAAC;;oBAEG,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;YAC5D,CAAC;QACL,CAAC;;YAEG,MAAM,IAAI,KAAK,CAAC,8BAA8B,aAAa,CAAC,OAAO,EAAE,CAAC,CAAC;IAC9E,CAAC;CACL;AAvGD,kDAuGC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@memberjunction/communication-engine",
3
- "version": "1.8.0",
3
+ "version": "2.0.0",
4
4
  "description": "MemberJunction: Core Communication Framework Library",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -19,11 +19,11 @@
19
19
  "typescript": "^5.4.5"
20
20
  },
21
21
  "dependencies": {
22
- "@memberjunction/global": "1.8.0",
23
- "@memberjunction/core": "1.8.0",
24
- "@memberjunction/templates": "1.8.0",
25
- "@memberjunction/core-entities": "1.8.0",
26
- "@memberjunction/communication-types": "1.8.0",
22
+ "@memberjunction/global": "2.0.0",
23
+ "@memberjunction/core": "2.0.0",
24
+ "@memberjunction/templates": "2.0.0",
25
+ "@memberjunction/core-entities": "2.0.0",
26
+ "@memberjunction/communication-types": "2.0.0",
27
27
  "rxjs": "^7.8.1"
28
28
  }
29
29
  }