@memberjunction/communication-types 2.27.0 → 2.28.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/BaseProvider.d.ts +63 -4
  2. package/dist/BaseProvider.d.ts.map +1 -1
  3. package/dist/BaseProvider.js +1 -0
  4. package/dist/BaseProvider.js.map +1 -1
  5. package/package.json +5 -5
package/dist/BaseProvider.d.ts CHANGED
@@ -110,7 +110,19 @@ export declare class MessageResult {
110
110
  Success: boolean;
111
111
  Error: string;
112
112
  }
113
+ export type BaseMessageResult = {
114
+ Success: boolean;
115
+ ErrorMessage?: string;
116
+ };
113
117
  export type GetMessagesParams<T = Record<string, any>> = {
118
+ /**
119
+ * The number of messages to return
120
+ */
121
+ NumMessages: number;
122
+ /**
123
+ * Optional. If true, only messages not marked as read will be returned
124
+ */
125
+ UnreadOnly?: boolean;
114
126
  /**
115
127
  * Optional, any provider-specific parameters that are needed to get messages
116
128
  */
@@ -118,12 +130,17 @@ export type GetMessagesParams<T = Record<string, any>> = {
118
130
  };
119
131
  export type GetMessageMessage = {
120
132
  From: string;
121
- ReplyTo: string[];
122
- Subject: string;
133
+ To: string;
123
134
  Body: string;
124
- ExternalSystemRecordID: string;
135
+ /**
136
+ * In some providers, such as MS Graph, replies can be sent to multiple other recipients
137
+ * rather than just the original sender
138
+ */
139
+ ReplyTo?: string[];
140
+ Subject?: string;
141
+ ExternalSystemRecordID?: string;
125
142
  };
126
- export type GetMessagesResult<T = Record<string, any>> = {
143
+ export type GetMessagesResult<T = Record<string, any>> = BaseMessageResult & {
127
144
  /**
128
145
  * If populated, holds provider-specific data that is returned from the provider
129
146
  */
@@ -133,6 +150,40 @@ export type GetMessagesResult<T = Record<string, any>> = {
133
150
  */
134
151
  Messages: GetMessageMessage[];
135
152
  };
153
+ export type ForwardMessageParams = {
154
+ /**
155
+ * The ID of the message to forward
156
+ */
157
+ MessageID: string;
158
+ /**
159
+ * An optional message to go along with the forwarded message
160
+ */
161
+ Message?: string;
162
+ ToRecipients: {
163
+ Name: string;
164
+ Address: string;
165
+ }[];
166
+ };
167
+ export type ForwardMessageResult<T = Record<string, any>> = BaseMessageResult & {
168
+ Result?: T;
169
+ };
170
+ export type ReplyToMessageParams<T = Record<string, any>> = {
171
+ /**
172
+ * The ID of the message to reply to
173
+ */
174
+ MessageID: string;
175
+ /**
176
+ * The message to send as a reply
177
+ */
178
+ Message: ProcessedMessage;
179
+ ContextData?: T;
180
+ };
181
+ export type ReplyToMessageResult<T = Record<string, any>> = BaseMessageResult & {
182
+ /**
183
+ * If populated, holds provider-specific result of replying to the message
184
+ */
185
+ Result?: T;
186
+ };
136
187
  /**
137
188
  * Base class for all communication providers. Each provider sub-classes this base class and implements functionality specific to the provider.
138
189
  */
@@ -145,6 +196,14 @@ export declare abstract class BaseCommunicationProvider {
145
196
  * Fetches messages using the provider
146
197
  */
147
198
  abstract GetMessages(params: GetMessagesParams): Promise<GetMessagesResult>;
199
+ /**
200
+ * Forwards a message to another client using the provider
201
+ */
202
+ abstract ForwardMessage(params: ForwardMessageParams): Promise<ForwardMessageResult>;
203
+ /**
204
+ * Replies to a message using the provider
205
+ */
206
+ abstract ReplyToMessage(params: ReplyToMessageParams): Promise<ReplyToMessageResult>;
148
207
  }
149
208
  export declare class CommunicationProviderEntityExtended extends CommunicationProviderEntity {
150
209
  private _ProviderMessageTypes;
package/dist/BaseProvider.d.ts.map CHANGED
@@ -1 +1 @@
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;;OAEG;IACI,QAAQ,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACI,EAAE,EAAE,MAAM,CAAC;IAElB;;OAEG;IACI,MAAM,CAAC,EAAE,IAAI,CAAC;IAErB;;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;CAMjC;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,MAAM,MAAM,iBAAiB,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI;IACrD;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,sBAAsB,EAAE,MAAM,CAAC;CAClC,CAAA;AAED,MAAM,MAAM,iBAAiB,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI;IACrD;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC;IACjB;;OAEG;IACH,QAAQ,EAAE,iBAAiB,EAAE,CAAC;CACjC,CAAC;AAEF;;GAEG;AACH,8BAAsB,yBAAyB;IAC3C;;OAEG;aACa,iBAAiB,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,aAAa,CAAC;IAEpF;;OAEG;aACa,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC;CACrF;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"}
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;;OAEG;IACI,QAAQ,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACI,EAAE,EAAE,MAAM,CAAC;IAElB;;OAEG;IACI,MAAM,CAAC,EAAE,IAAI,CAAC;IAErB;;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;CAMjC;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,MAAM,MAAM,iBAAiB,GAAG;IAC5B,OAAO,EAAE,OAAO,CAAC;IACjB,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB,CAAA;AAED,MAAM,MAAM,iBAAiB,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI;IACrD;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,iBAAiB,GAAG;IACzE;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC;IACjB;;OAEG;IACH,QAAQ,EAAE,iBAAiB,EAAE,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IAC/B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAIjB,YAAY,EAAE;QACV,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;KACnB,EAAE,CAAC;CACP,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,iBAAiB,GAAG;IAC5E,MAAM,CAAC,EAAE,CAAC,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI;IACxD;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,OAAO,EAAE,gBAAgB,CAAC;IAK1B,WAAW,CAAC,EAAE,CAAC,CAAA;CAClB,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,iBAAiB,GAAG;IAC5E;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,CAAC;CACd,CAAC;AAGF;;GAEG;AACH,8BAAsB,yBAAyB;IAC3C;;OAEG;aACa,iBAAiB,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,aAAa,CAAC;IAEpF;;OAEG;aACa,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAElF;;OAEG;aACa,cAAc,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAE3F;;OAEG;aACa,cAAc,CAAC,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC;CAE9F;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 CHANGED
@@ -40,6 +40,7 @@ exports.ProcessedMessage = ProcessedMessage;
40
40
  class MessageResult {
41
41
  }
42
42
  exports.MessageResult = MessageResult;
43
+ ;
43
44
  /**
44
45
  * Base class for all communication providers. Each provider sub-classes this base class and implements functionality specific to the provider.
45
46
  */
package/dist/BaseProvider.js.map CHANGED
@@ -1 +1 @@
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;IAiEhB,YAAY,QAAkB;QAC1B,yEAAyE;QACzE,IAAI,QAAQ,EAAC,CAAC;YACV,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAClC,CAAC;IACL,CAAC;CACJ;AAvED,0BAuEC;AAED;;GAEG;AACH,MAAsB,gBAAiB,SAAQ,OAAO;CAkBrD;AAlBD,4CAkBC;AAED;;GAEG;AACH,MAAa,aAAa;CAKzB;AALD,sCAKC;AA4BD;;GAEG;AACH,MAAsB,yBAAyB;CAU9C;AAVD,8DAUC;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"}
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;IAiEhB,YAAY,QAAkB;QAC1B,yEAAyE;QACzE,IAAI,QAAQ,EAAC,CAAC;YACV,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAClC,CAAC;IACL,CAAC;CACJ;AAvED,0BAuEC;AAED;;GAEG;AACH,MAAsB,gBAAiB,SAAQ,OAAO;CAkBrD;AAlBD,4CAkBC;AAED;;GAEG;AACH,MAAa,aAAa;CAKzB;AALD,sCAKC;AAAA,CAAC;AA4FF;;GAEG;AACH,MAAsB,yBAAyB;CAqB9C;AArBD,8DAqBC;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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@memberjunction/communication-types",
3
- "version": "2.27.0",
3
+ "version": "2.28.0",
4
4
  "description": "MemberJunction: Communication Framework Library Generic Types",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -19,10 +19,10 @@
19
19
  "typescript": "^5.4.5"
20
20
  },
21
21
  "dependencies": {
22
- "@memberjunction/global": "2.27.0",
23
- "@memberjunction/core": "2.27.0",
24
- "@memberjunction/templates-base-types": "2.27.0",
25
- "@memberjunction/core-entities": "2.27.0",
22
+ "@memberjunction/global": "2.28.0",
23
+ "@memberjunction/core": "2.28.0",
24
+ "@memberjunction/templates-base-types": "2.28.0",
25
+ "@memberjunction/core-entities": "2.28.0",
26
26
  "rxjs": "^7.8.1"
27
27
  }
28
28
  }