@memberjunction/communication-types 2.6.1 → 2.7.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 (4) hide show
  1. package/dist/BaseProvider.d.ts +16 -0
  2. package/dist/BaseProvider.d.ts.map +1 -1
  3. package/dist/BaseProvider.js.map +1 -1
  4. package/package.json +5 -5
package/dist/BaseProvider.d.ts CHANGED
@@ -106,6 +106,18 @@ export declare class MessageResult {
106
106
  Success: boolean;
107
107
  Error: string;
108
108
  }
109
+ export type GetMessagesParams<T = Record<string, any>> = {
110
+ /**
111
+ * Optional, any provider-specific parameters that are needed to get messages
112
+ */
113
+ ContextData?: T;
114
+ };
115
+ export type GetMessagesResult<T = Record<string, any>> = {
116
+ /**
117
+ * If populated, holds provider-specific data that is returned from the provider
118
+ */
119
+ SourceData?: T[];
120
+ };
109
121
  /**
110
122
  * Base class for all communication providers. Each provider sub-classes this base class and implements functionality specific to the provider.
111
123
  */
@@ -114,6 +126,10 @@ export declare abstract class BaseCommunicationProvider {
114
126
  *
115
127
  */
116
128
  abstract SendSingleMessage(message: ProcessedMessage): Promise<MessageResult>;
129
+ /**
130
+ * Fetches messages using the provider
131
+ */
132
+ abstract GetMessages(params: GetMessagesParams): Promise<GetMessagesResult>;
117
133
  }
118
134
  export declare class CommunicationProviderEntityExtended extends CommunicationProviderEntity {
119
135
  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;;;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;;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"}
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,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,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI;IACrD;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC;CACpB,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"}
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;IA4DhB,YAAY,QAAkB;QAC1B,yEAAyE;QACzE,IAAI,QAAQ,EAAC,CAAC;YACV,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAClC,CAAC;IACL,CAAC;CACJ;AAlED,0BAkEC;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"}
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;IA4DhB,YAAY,QAAkB;QAC1B,yEAAyE;QACzE,IAAI,QAAQ,EAAC,CAAC;YACV,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAClC,CAAC;IACL,CAAC;CACJ;AAlED,0BAkEC;AAED;;GAEG;AACH,MAAsB,gBAAiB,SAAQ,OAAO;CAkBrD;AAlBD,4CAkBC;AAED;;GAEG;AACH,MAAa,aAAa;CAKzB;AALD,sCAKC;AAgBD;;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"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@memberjunction/communication-types",
3
- "version": "2.6.1",
3
+ "version": "2.7.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.6.1",
23
- "@memberjunction/core": "2.6.1",
24
- "@memberjunction/templates-base-types": "2.6.1",
25
- "@memberjunction/core-entities": "2.6.1",
22
+ "@memberjunction/global": "2.7.0",
23
+ "@memberjunction/core": "2.7.0",
24
+ "@memberjunction/templates-base-types": "2.7.0",
25
+ "@memberjunction/core-entities": "2.7.0",
26
26
  "rxjs": "^7.8.1"
27
27
  }
28
28
  }