@veramo/message-handler 3.1.5-next.122 → 3.1.5-next.126

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.
@@ -6,7 +6,18 @@ export declare const EventTypes: {
6
6
  error: string;
7
7
  };
8
8
  /**
9
- * Agent plugin that provides {@link @veramo/core#IMessageHandler} methods
9
+ * A Veramo agent plugin that implements {@link @veramo/core#IMessageHandler | IMessageHandler} methods.
10
+ *
11
+ * This plugin is meant to chain together multiple other {@link @veramo/core#IMessageHandler | IMessageHandler}
12
+ * implementations.
13
+ *
14
+ * When handling a message, the message is passed from one handler to the next, and each handler in
15
+ * the chain can decide if it is able to interpret the message.
16
+ *
17
+ * If the message can be processed by a handler it is returned as an {@link @veramo/core#IMessage | IMessage}.
18
+ * If the message cannot be processed by any of the handlers, an error is thrown.
19
+ *
20
+ * @public
10
21
  */
11
22
  export declare class MessageHandler implements IAgentPlugin {
12
23
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"message-handler.d.ts","sourceRoot":"","sources":["../src/message-handler.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,YAAY,EACZ,aAAa,EACb,eAAe,EACf,kBAAkB,EAGlB,QAAQ,EACT,MAAM,cAAc,CAAA;AAErB,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAA;AAKnE,eAAO,MAAM,UAAU;;;;CAItB,CAAA;AAED;;GAEG;AACH,qBAAa,cAAe,YAAW,YAAY;IACjD;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAA;IACjC,QAAQ,CAAC,MAAM,MAAyB;IACxC,OAAO,CAAC,cAAc,CAAC,CAAwB;gBAEnC,OAAO,EAAE;QAAE,eAAe,EAAE,sBAAsB,EAAE,CAAA;KAAE;IAmBlE,+DAA+D;IAClD,aAAa,CACxB,IAAI,EAAE,kBAAkB,EACxB,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,GACjC,OAAO,CAAC,QAAQ,CAAC;CA2BrB"}
1
+ {"version":3,"file":"message-handler.d.ts","sourceRoot":"","sources":["../src/message-handler.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,YAAY,EACZ,aAAa,EACb,eAAe,EACf,kBAAkB,EAGlB,QAAQ,EACT,MAAM,cAAc,CAAA;AAErB,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAA;AAMnE,eAAO,MAAM,UAAU;;;;CAItB,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,qBAAa,cAAe,YAAW,YAAY;IACjD;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAA;IACjC,QAAQ,CAAC,MAAM,MAAyB;IACxC,OAAO,CAAC,cAAc,CAAC,CAAwB;gBAEnC,OAAO,EAAE;QAAE,eAAe,EAAE,sBAAsB,EAAE,CAAA;KAAE;IAmBlE,+DAA+D;IAClD,aAAa,CACxB,IAAI,EAAE,kBAAkB,EACxB,OAAO,EAAE,aAAa,CAAC,UAAU,CAAC,GACjC,OAAO,CAAC,QAAQ,CAAC;CA2BrB"}
@@ -23,7 +23,18 @@ exports.EventTypes = {
23
23
  error: core_1.CoreEvents.error,
24
24
  };
25
25
  /**
26
- * Agent plugin that provides {@link @veramo/core#IMessageHandler} methods
26
+ * A Veramo agent plugin that implements {@link @veramo/core#IMessageHandler | IMessageHandler} methods.
27
+ *
28
+ * This plugin is meant to chain together multiple other {@link @veramo/core#IMessageHandler | IMessageHandler}
29
+ * implementations.
30
+ *
31
+ * When handling a message, the message is passed from one handler to the next, and each handler in
32
+ * the chain can decide if it is able to interpret the message.
33
+ *
34
+ * If the message can be processed by a handler it is returned as an {@link @veramo/core#IMessage | IMessage}.
35
+ * If the message cannot be processed by any of the handlers, an error is thrown.
36
+ *
37
+ * @public
27
38
  */
28
39
  class MessageHandler {
29
40
  constructor(options) {
@@ -1 +1 @@
1
- {"version":3,"file":"message-handler.js","sourceRoot":"","sources":["../src/message-handler.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uCASqB;AACrB,uCAAmC;AAGnC,kDAAyB;AACzB,MAAM,KAAK,GAAG,IAAA,eAAK,EAAC,wBAAwB,CAAC,CAAA;AAEhC,QAAA,UAAU,GAAG;IACxB,gBAAgB,EAAE,kBAAkB;IACpC,YAAY,EAAE,cAAc;IAC5B,KAAK,EAAE,iBAAU,CAAC,KAAK;CACxB,CAAA;AAED;;GAEG;AACH,MAAa,cAAc;IASzB,YAAY,OAAsD;QAHzD,WAAM,GAAG,aAAM,CAAC,eAAe,CAAA;QAItC,KAAK,MAAM,cAAc,IAAI,OAAO,CAAC,eAAe,EAAE;YACpD,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;gBACxB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAA;aACrC;iBAAM;gBACL,IAAI,WAAW,GAAG,IAAI,CAAC,cAAc,CAAA;gBACrC,OAAO,WAAW,CAAC,kBAAkB,KAAK,SAAS,EAAE;oBACnD,WAAW,GAAG,WAAW,CAAC,kBAAkB,CAAA;iBAC7C;gBACD,WAAW,CAAC,OAAO,CAAC,cAAc,CAAC,CAAA;aACpC;SACF;QAED,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAClD,IAAI,CAAC,OAAO,GAAG;YACb,aAAa,EAAE,IAAI,CAAC,aAAa;SAClC,CAAA;IACH,CAAC;IAED,+DAA+D;IAClD,aAAa,CACxB,IAAwB,EACxB,OAAkC;;YAElC,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,IAAI,CAAA;YACpC,KAAK,CAAC,IAAI,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAA;YACpC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;gBACxB,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC,CAAA;aACjE;YAED,IAAI;gBACF,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,iBAAO,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,EAAE,OAAO,CAAC,CAAA;gBACzF,IAAI,OAAO,CAAC,OAAO,EAAE,EAAE;oBACrB,KAAK,CAAC,gBAAgB,EAAE,kBAAU,CAAC,gBAAgB,CAAC,CAAA;oBACpD,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,kBAAU,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAA;iBACzD;gBAED,KAAK,CAAC,sBAAsB,EAAE,OAAO,CAAC,CAAA;gBACtC,IAAI,IAAI,EAAE;oBACR,MAAM,OAAO,CAAC,KAAK,CAAC,oBAAoB,CAAC,EAAE,OAAO,EAAE,CAAC,CAAA;oBACrD,KAAK,CAAC,gBAAgB,EAAE,kBAAU,CAAC,YAAY,CAAC,CAAA;oBAChD,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,kBAAU,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;iBACrD;gBACD,OAAO,OAAO,CAAA;aACf;YAAC,OAAO,KAAK,EAAE;gBACd,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;gBACrB,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,kBAAU,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;gBAC3C,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;aAC7B;QACH,CAAC;KAAA;CACF;AA3DD,wCA2DC"}
1
+ {"version":3,"file":"message-handler.js","sourceRoot":"","sources":["../src/message-handler.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,uCASqB;AACrB,uCAAmC;AAGnC,kDAAyB;AAEzB,MAAM,KAAK,GAAG,IAAA,eAAK,EAAC,wBAAwB,CAAC,CAAA;AAEhC,QAAA,UAAU,GAAG;IACxB,gBAAgB,EAAE,kBAAkB;IACpC,YAAY,EAAE,cAAc;IAC5B,KAAK,EAAE,iBAAU,CAAC,KAAK;CACxB,CAAA;AAED;;;;;;;;;;;;;GAaG;AACH,MAAa,cAAc;IASzB,YAAY,OAAsD;QAHzD,WAAM,GAAG,aAAM,CAAC,eAAe,CAAA;QAItC,KAAK,MAAM,cAAc,IAAI,OAAO,CAAC,eAAe,EAAE;YACpD,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;gBACxB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAA;aACrC;iBAAM;gBACL,IAAI,WAAW,GAAG,IAAI,CAAC,cAAc,CAAA;gBACrC,OAAO,WAAW,CAAC,kBAAkB,KAAK,SAAS,EAAE;oBACnD,WAAW,GAAG,WAAW,CAAC,kBAAkB,CAAA;iBAC7C;gBACD,WAAW,CAAC,OAAO,CAAC,cAAc,CAAC,CAAA;aACpC;SACF;QAED,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAClD,IAAI,CAAC,OAAO,GAAG;YACb,aAAa,EAAE,IAAI,CAAC,aAAa;SAClC,CAAA;IACH,CAAC;IAED,+DAA+D;IAClD,aAAa,CACxB,IAAwB,EACxB,OAAkC;;YAElC,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,IAAI,CAAA;YACpC,KAAK,CAAC,IAAI,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAA;YACpC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;gBACxB,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC,CAAA;aACjE;YAED,IAAI;gBACF,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,IAAI,iBAAO,CAAC,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,EAAE,OAAO,CAAC,CAAA;gBACzF,IAAI,OAAO,CAAC,OAAO,EAAE,EAAE;oBACrB,KAAK,CAAC,gBAAgB,EAAE,kBAAU,CAAC,gBAAgB,CAAC,CAAA;oBACpD,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,kBAAU,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAA;iBACzD;gBAED,KAAK,CAAC,sBAAsB,EAAE,OAAO,CAAC,CAAA;gBACtC,IAAI,IAAI,EAAE;oBACR,MAAM,OAAO,CAAC,KAAK,CAAC,oBAAoB,CAAC,EAAE,OAAO,EAAE,CAAC,CAAA;oBACrD,KAAK,CAAC,gBAAgB,EAAE,kBAAU,CAAC,YAAY,CAAC,CAAA;oBAChD,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,kBAAU,CAAC,YAAY,EAAE,OAAO,CAAC,CAAA;iBACrD;gBACD,OAAO,OAAO,CAAA;aACf;YAAC,OAAO,KAAK,EAAE;gBACd,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;gBACrB,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,kBAAU,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA;gBAC3C,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;aAC7B;QACH,CAAC;KAAA;CACF;AA3DD,wCA2DC"}
@@ -1,4 +1,11 @@
1
1
  import { IMessage, IMetaData, VerifiableCredential, VerifiablePresentation } from '@veramo/core';
2
+ /**
3
+ * A class implementing {@link @veramo/core#IMessage | IMessage}.
4
+ *
5
+ * This is used by {@link @veramo/message-handler#MessageHandler | MessageHandler}.
6
+ *
7
+ * @public
8
+ */
2
9
  export declare class Message implements IMessage {
3
10
  constructor(data?: {
4
11
  raw: string;
@@ -1 +1 @@
1
- {"version":3,"file":"message.d.ts","sourceRoot":"","sources":["../src/message.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAA;AAEhG,qBAAa,OAAQ,YAAW,QAAQ;gBAC1B,IAAI,CAAC,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAA;KAAE;IAU1D,EAAE,EAAE,MAAM,CAAA;IAEV,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB,QAAQ,CAAC,EAAE,MAAM,CAAA;IAGjB,IAAI,EAAE,MAAM,CAAA;IAEZ,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ,IAAI,CAAC,EAAE,GAAG,CAAA;IAEV,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAElB,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAA;IAEtB,aAAa,CAAC,EAAE,sBAAsB,EAAE,CAAA;IACxC,WAAW,CAAC,EAAE,oBAAoB,EAAE,CAAA;IAEpC,WAAW,CAAC,IAAI,EAAE,SAAS;IAQ3B,eAAe,IAAI,SAAS,GAAG,IAAI;IAQnC,OAAO;CASR"}
1
+ {"version":3,"file":"message.d.ts","sourceRoot":"","sources":["../src/message.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAA;AAEhG;;;;;;GAMG;AACH,qBAAa,OAAQ,YAAW,QAAQ;gBAC1B,IAAI,CAAC,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAA;KAAE;IAU1D,EAAE,EAAE,MAAM,CAAA;IAEV,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB,QAAQ,CAAC,EAAE,MAAM,CAAA;IAGjB,IAAI,EAAE,MAAM,CAAA;IAEZ,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ,IAAI,CAAC,EAAE,GAAG,CAAA;IAEV,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAElB,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAA;IAEtB,aAAa,CAAC,EAAE,sBAAsB,EAAE,CAAA;IACxC,WAAW,CAAC,EAAE,oBAAoB,EAAE,CAAA;IAEpC,WAAW,CAAC,IAAI,EAAE,SAAS;IAQ3B,eAAe,IAAI,SAAS,GAAG,IAAI;IAQnC,OAAO;CASR"}
package/build/message.js CHANGED
@@ -1,6 +1,13 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.Message = void 0;
4
+ /**
5
+ * A class implementing {@link @veramo/core#IMessage | IMessage}.
6
+ *
7
+ * This is used by {@link @veramo/message-handler#MessageHandler | MessageHandler}.
8
+ *
9
+ * @public
10
+ */
4
11
  class Message {
5
12
  constructor(data) {
6
13
  if (data === null || data === void 0 ? void 0 : data.raw) {
@@ -1 +1 @@
1
- {"version":3,"file":"message.js","sourceRoot":"","sources":["../src/message.ts"],"names":[],"mappings":";;;AAEA,MAAa,OAAO;IAClB,YAAY,IAA8C;QACxD,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,GAAG,EAAE;YACb,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAA;SACpB;QACD,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,EAAE;YAClB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAA;SAC9B;IACH,CAAC;IA+BD,WAAW,CAAC,IAAe;QACzB,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;SACzB;aAAM;YACL,IAAI,CAAC,QAAQ,GAAG,CAAC,IAAI,CAAC,CAAA;SACvB;IACH,CAAC;IAED,eAAe;QACb,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YAC3D,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;SAC/C;aAAM;YACL,OAAO,IAAI,CAAA;SACZ;IACH,CAAC;IAED,OAAO;QACL,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,EAAE,EAAE;YAC1C,OAAO,KAAK,CAAA;SACb;QACD,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,KAAK,IAAI,IAAI,IAAI,CAAC,GAAG,KAAK,EAAE,EAAE;YACrD,OAAO,KAAK,CAAA;SACb;QACD,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AAhED,0BAgEC"}
1
+ {"version":3,"file":"message.js","sourceRoot":"","sources":["../src/message.ts"],"names":[],"mappings":";;;AAEA;;;;;;GAMG;AACH,MAAa,OAAO;IAClB,YAAY,IAA8C;QACxD,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,GAAG,EAAE;YACb,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAA;SACpB;QACD,IAAI,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,QAAQ,EAAE;YAClB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAA;SAC9B;IACH,CAAC;IA+BD,WAAW,CAAC,IAAe;QACzB,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;SACzB;aAAM;YACL,IAAI,CAAC,QAAQ,GAAG,CAAC,IAAI,CAAC,CAAA;SACvB;IACH,CAAC;IAED,eAAe;QACb,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YAC3D,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAA;SAC/C;aAAM;YACL,OAAO,IAAI,CAAA;SACZ;IACH,CAAC;IAED,OAAO;QACL,IAAI,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,EAAE,EAAE;YAC1C,OAAO,KAAK,CAAA;SACb;QACD,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,KAAK,IAAI,IAAI,IAAI,CAAC,GAAG,KAAK,EAAE,EAAE;YACrD,OAAO,KAAK,CAAA;SACb;QACD,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AAhED,0BAgEC"}
@@ -5,7 +5,7 @@
5
5
  "toolPackages": [
6
6
  {
7
7
  "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.23.1"
8
+ "packageVersion": "7.24.2"
9
9
  }
10
10
  ]
11
11
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@veramo/message-handler",
3
3
  "description": "Message Handler plugin for Veramo",
4
- "version": "3.1.5-next.122+180af512",
4
+ "version": "3.1.5-next.126+219cde25",
5
5
  "main": "build/index.js",
6
6
  "types": "build/index.d.ts",
7
7
  "scripts": {
@@ -9,7 +9,7 @@
9
9
  "extract-api": "yarn veramo dev extract-api"
10
10
  },
11
11
  "dependencies": {
12
- "@veramo/core": "^3.1.5-next.122+180af512"
12
+ "@veramo/core": "^3.1.5-next.126+219cde25"
13
13
  },
14
14
  "devDependencies": {
15
15
  "typescript": "4.7.3"
@@ -33,5 +33,5 @@
33
33
  ],
34
34
  "license": "Apache-2.0",
35
35
  "keywords": [],
36
- "gitHead": "180af5122146e0b2022a70a1689f5891edec117a"
36
+ "gitHead": "219cde250e8d4f06d7978afcc38a04471342fd21"
37
37
  }
@@ -12,6 +12,7 @@ import { Message } from './message'
12
12
  import { AbstractMessageHandler } from './abstract-message-handler'
13
13
 
14
14
  import Debug from 'debug'
15
+
15
16
  const debug = Debug('veramo:message-handler')
16
17
 
17
18
  export const EventTypes = {
@@ -21,7 +22,18 @@ export const EventTypes = {
21
22
  }
22
23
 
23
24
  /**
24
- * Agent plugin that provides {@link @veramo/core#IMessageHandler} methods
25
+ * A Veramo agent plugin that implements {@link @veramo/core#IMessageHandler | IMessageHandler} methods.
26
+ *
27
+ * This plugin is meant to chain together multiple other {@link @veramo/core#IMessageHandler | IMessageHandler}
28
+ * implementations.
29
+ *
30
+ * When handling a message, the message is passed from one handler to the next, and each handler in
31
+ * the chain can decide if it is able to interpret the message.
32
+ *
33
+ * If the message can be processed by a handler it is returned as an {@link @veramo/core#IMessage | IMessage}.
34
+ * If the message cannot be processed by any of the handlers, an error is thrown.
35
+ *
36
+ * @public
25
37
  */
26
38
  export class MessageHandler implements IAgentPlugin {
27
39
  /**
package/src/message.ts CHANGED
@@ -1,5 +1,12 @@
1
1
  import { IMessage, IMetaData, VerifiableCredential, VerifiablePresentation } from '@veramo/core'
2
2
 
3
+ /**
4
+ * A class implementing {@link @veramo/core#IMessage | IMessage}.
5
+ *
6
+ * This is used by {@link @veramo/message-handler#MessageHandler | MessageHandler}.
7
+ *
8
+ * @public
9
+ */
3
10
  export class Message implements IMessage {
4
11
  constructor(data?: { raw: string; metaData?: IMetaData[] }) {
5
12
  if (data?.raw) {