{"_id":"@adorsys-gis/message-exchange","_rev":"7-8f424ba6dfe7f7e405cfa0b2a5366312","name":"@adorsys-gis/message-exchange","dist-tags":{"latest":"1.0.4"},"versions":{"1.0.0":{"name":"@adorsys-gis/message-exchange","version":"1.0.0","author":{"name":"adorsys"},"license":"ISC","_id":"@adorsys-gis/message-exchange@1.0.0","maintainers":[{"name":"francis-pouatcha","email":"francis.pouatcha@adorsys.com"},{"name":"awambeng","email":"awambengrodrick@gmail.com"}],"dist":{"shasum":"09bacaf33616066b4ea73a70aea32dbbb36ae0df","tarball":"https://registry.npmjs.org/@adorsys-gis/message-exchange/-/message-exchange-1.0.0.tgz","fileCount":42,"integrity":"sha512-AwmRkQ401obL8uCXFDAXa9smalOpVF+SGcGHjYaYuTE9Y66Fea8ZAGDrL//ZcctTEQBYICgz4k4Hg5g/gku6Ig==","signatures":[{"sig":"MEUCIBAeR0xBh6gF4q1wPpbcn0pkmJUx920kBZdow4GwoowAAiEA19vprFVTexcJNS4ycCuY7/RM7oN+gzAuS9de60L/Z30=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":98766},"main":"dist/src/index.js","gitHead":"554afc6c1b8f6fe00f2374beb308fe8265f5e5d2","scripts":{"lint":"eslint .","test":"vitest --run","build":"tsc","format":"prettier --write ."},"typings":"dist/src/index.d.ts","_npmUser":{"name":"awambeng","email":"awambengrodrick@gmail.com"},"_npmVersion":"10.9.2","description":"A library for DIDComm message routing.","directories":{},"_nodeVersion":"20.15.1","dependencies":{"didcomm":"^0.4.1","@scure/base":"^1.2.4","cross-fetch":"^4.1.0","did-resolver-lib":"https://gitpkg.vercel.app/adorsys/didcomm-messaging-clients-utilities/libs/did-resolver-lib?main","@adorsys-gis/status-service":"^1.0.0","@adorsys-gis/message-service":"^1.0.1","@adorsys-gis/cloning-decorator":"^1.0.1","@adorsys-gis/multiple-did-identities":"^1.0.2"},"_hasShrinkwrap":false,"devDependencies":{"nock":"^14.0.0","tslib":"*","eslint":"*","vitest":"^3.0.4","@vitest/ui":"^3.0.4","@types/node":"*","eventemitter3":"^5.0.1","fake-indexeddb":"^6.0.0","vite-plugin-wasm":"^3.3.0","@vitest/coverage-v8":"^3.0.4","jsonc-eslint-parser":"*","@typescript-eslint/parser":"*","@typescript-eslint/eslint-plugin":"*"},"_npmOperationalInternal":{"tmp":"tmp/message-exchange_1.0.0_1739351297951_0.420302044592644","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@adorsys-gis/message-exchange","version":"1.0.1","author":{"name":"adorsys"},"license":"ISC","_id":"@adorsys-gis/message-exchange@1.0.1","maintainers":[{"name":"francis-pouatcha","email":"francis.pouatcha@adorsys.com"},{"name":"awambeng","email":"awambengrodrick@gmail.com"}],"dist":{"shasum":"7374f0850a6c0bd308caee6c8d87af7ad70e0bed","tarball":"https://registry.npmjs.org/@adorsys-gis/message-exchange/-/message-exchange-1.0.1.tgz","fileCount":49,"integrity":"sha512-nxcm3haL19AA+hB4gV12BaANiSaw5Y7VFBFVlwjVRVbwSMqIucjeqBHCTa2+NalUtEw7LweK2uzLZqlh1be6Ag==","signatures":[{"sig":"MEYCIQDoiNznvbcKJUGCGJuYDhJNstUe1Jd7Ba2UZBw/3tLNCwIhAJwjWisVQgxpsHCPH38ADs6Aqgh7wNkV3c02m2WEjJf9","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":114455},"main":"dist/src/index.js","gitHead":"0b9879d8204bc9ccf9c14900abc679f1b6bd5891","scripts":{"lint":"eslint . --no-error-on-unmatched-pattern","test":"vitest --run","build":"tsc","format":"prettier --write .","lint:fix":"eslint . --fix"},"typings":"dist/src/index.d.ts","_npmUser":{"name":"awambeng","email":"awambengrodrick@gmail.com"},"_npmVersion":"10.9.2","description":"A library for DIDComm message routing.","directories":{},"_nodeVersion":"20.15.1","dependencies":{"didcomm":"^0.4.1","@scure/base":"^1.2.4","cross-fetch":"^4.1.0","did-resolver-lib":"https://gitpkg.vercel.app/adorsys/didcomm-messaging-clients-utilities/libs/did-resolver-lib?main","@adorsys-gis/status-service":"^1.0.0","@adorsys-gis/message-service":"^1.0.2","@adorsys-gis/cloning-decorator":"^1.0.1","@adorsys-gis/multiple-did-identities":"^1.0.2"},"_hasShrinkwrap":false,"devDependencies":{"nock":"^14.0.0","tslib":"*","eslint":"*","vitest":"^3.0.4","@vitest/ui":"^3.0.4","@types/node":"*","eventemitter3":"^5.0.1","fake-indexeddb":"*","vite-plugin-wasm":"^3.3.0","@vitest/coverage-v8":"^3.0.4","jsonc-eslint-parser":"*","@typescript-eslint/parser":"*","@typescript-eslint/eslint-plugin":"*"},"_npmOperationalInternal":{"tmp":"tmp/message-exchange_1.0.1_1739888320145_0.030999437897810456","host":"s3://npm-registry-packages-npm-production"}},"1.0.3":{"name":"@adorsys-gis/message-exchange","version":"1.0.3","author":{"name":"adorsys"},"license":"ISC","_id":"@adorsys-gis/message-exchange@1.0.3","maintainers":[{"name":"francis-pouatcha","email":"francis.pouatcha@adorsys.com"},{"name":"awambeng","email":"awambengrodrick@gmail.com"},{"name":"t.arthur","email":"tcheutchouaarthur38@gmail.com"}],"dist":{"shasum":"5193b4b8168cd1a770f7f9ecc7d97b59253b0203","tarball":"https://registry.npmjs.org/@adorsys-gis/message-exchange/-/message-exchange-1.0.3.tgz","fileCount":43,"integrity":"sha512-xqDBsduJwpZp8EQlYXR8CwwspzZujBRtt/94SUFbpC4q4L9f7nokOWdqvjHx130N2HEoEt9EL9uOdWC76C19Uw==","signatures":[{"sig":"MEYCIQCXt0EAfhx/DPflAHxCVpdnI7lDFrBwx4pIAIxNzE7WfAIhAIqpY0zwaTMHReRy7PmpCDiGw+IZj9s1YiUTgTUE5rCI","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":97565},"main":"dist/src/index.js","gitHead":"996ebddedb9fc15804b3dd03c212b300f85ea9e4","scripts":{"lint":"eslint . --no-error-on-unmatched-pattern","test":"vitest --run","build":"tsc","format":"prettier --write .","lint:fix":"eslint . --fix"},"typings":"dist/src/index.d.ts","_npmUser":{"name":"awambeng","email":"awambengrodrick@gmail.com"},"_npmVersion":"10.9.2","description":"A library for DIDComm message routing.","directories":{},"_nodeVersion":"20.15.1","dependencies":{"didcomm":"^0.4.1","prettier":"^3.5.2","@scure/base":"^1.2.4","cross-fetch":"^4.1.0","did-resolver-lib":"https://gitpkg.vercel.app/adorsys/didcomm-messaging-clients-utilities/libs/did-resolver-lib?main","@adorsys-gis/status-service":"^1.0.0","@adorsys-gis/message-service":"^1.0.3","@adorsys-gis/cloning-decorator":"^1.0.1","@adorsys-gis/multiple-did-identities":"^1.0.7"},"_hasShrinkwrap":false,"devDependencies":{"nock":"^14.0.0","tslib":"*","eslint":"*","vitest":"^3.0.4","@vitest/ui":"^3.0.4","@types/node":"*","eventemitter3":"^5.0.1","fake-indexeddb":"*","vite-plugin-wasm":"^3.3.0","@vitest/coverage-v8":"^3.0.4","jsonc-eslint-parser":"*","@typescript-eslint/parser":"*","@typescript-eslint/eslint-plugin":"*"},"_npmOperationalInternal":{"tmp":"tmp/message-exchange_1.0.3_1742373975930_0.6941620717276458","host":"s3://npm-registry-packages-npm-production"}},"1.0.4":{"name":"@adorsys-gis/message-exchange","version":"1.0.4","description":"A library for DIDComm message routing.","license":"ISC","author":{"name":"adorsys"},"main":"dist/src/index.js","typings":"dist/src/index.d.ts","scripts":{"build":"tsc -p tsconfig.lib.json","format":"prettier --write .","lint":"eslint . --no-error-on-unmatched-pattern","lint:fix":"eslint . --fix","test":"vitest --run"},"dependencies":{"@adorsys-gis/cloning-decorator":"^1.0.1","@adorsys-gis/did-resolver-lib":"^1.0.1","@adorsys-gis/message-service":"^1.0.3","@adorsys-gis/multiple-did-identities":"^1.0.7","@adorsys-gis/shared-utils":"1.0.1","@adorsys-gis/status-service":"^1.0.0","@scure/base":"^1.2.4","cross-fetch":"^4.1.0","didcomm":"^0.4.1","prettier":"^3.5.2"},"devDependencies":{"@types/node":"*","@typescript-eslint/eslint-plugin":"*","@typescript-eslint/parser":"*","@vitest/coverage-v8":"^3.0.4","@vitest/ui":"^3.0.4","eslint":"*","eventemitter3":"^5.0.1","fake-indexeddb":"*","jsonc-eslint-parser":"*","nock":"^14.0.0","tslib":"*","vite-plugin-wasm":"^3.3.0","vitest":"^3.0.4"},"_id":"@adorsys-gis/message-exchange@1.0.4","gitHead":"51db2b9bcd6e0b38e7d690c82509590577a25626","_nodeVersion":"20.15.1","_npmVersion":"10.9.2","dist":{"integrity":"sha512-vvqmrP6vTPsqJR8hqw4H5zY3tQu96+Q+cyi6cAI11HJydTOqNK/2INkK6L5qyfaVO/IVOnrzJdntewfsVKpPUQ==","shasum":"bc87e5d7312664b64b557c67b93a535d59154d61","tarball":"https://registry.npmjs.org/@adorsys-gis/message-exchange/-/message-exchange-1.0.4.tgz","fileCount":40,"unpackedSize":78678,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDEBLTbZr1EB8aEMenol/GUzid281iP6cUR43uJauz43AIhAIr8mwQF5GkmUGDSXDYuF2d6uMeMVm5wCtbrFiCuvH8J"}]},"_npmUser":{"name":"awambeng","email":"awambengrodrick@gmail.com"},"directories":{},"maintainers":[{"name":"francis-pouatcha","email":"francis.pouatcha@adorsys.com"},{"name":"awambeng","email":"awambengrodrick@gmail.com"},{"name":"t.arthur","email":"tcheutchouaarthur38@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/message-exchange_1.0.4_1744798564684_0.4437391195156499"},"_hasShrinkwrap":false}},"time":{"created":"2025-02-12T09:08:17.848Z","modified":"2025-04-16T10:16:05.061Z","1.0.0":"2025-02-12T09:08:18.120Z","1.0.2":"2025-02-14T15:22:52.253Z","1.0.1":"2025-02-18T14:18:40.442Z","1.0.3":"2025-03-19T08:46:16.108Z","1.0.4":"2025-04-16T10:16:04.862Z"},"author":{"name":"adorsys"},"license":"ISC","description":"A library for DIDComm message routing.","maintainers":[{"name":"francis-pouatcha","email":"francis.pouatcha@adorsys.com"},{"name":"awambeng","email":"awambengrodrick@gmail.com"},{"name":"t.arthur","email":"tcheutchouaarthur38@gmail.com"}],"readme":"# Message Exchange\n\nA library for implementing services to support message exchange between DIDComm agents.\n\n## Features\n\n| **Protocol**                                                                                       | **Description**                                        | **Status**     |\n| -------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | -------------- |\n| [DIDComm Message Routing](https://identity.foundation/didcomm-messaging/spec/#routing-protocol-20) | Send a message to a DIDComm agent via their mediators. | ✅ Implemented |\n| [Message Pickup](https://didcomm.org/messagepickup/3.0)                                            | Pick up messages from mediators.                       | ✅ Implemented |\n\n## Installation\n\n```bash\nnpm install @adorsys-gis/message-exchange\n```\n\n## Usage\n\n### Prerequisites\n\nBefore using the library, you'll need a DID address for the sending party.\nThis can be created using the `DIDIdentityService` from the peer library\n`@adorsys-gis/multiple-did-identities`. Here's an example of generating\na DID using that library:\n\n```ts\nexport const generateIdentity = async (secretPinNumber: number) => {\n  const createEvent = waitForEvent(DidEventChannel.CreateDidIdentity);\n\n  didIdentityService.createDidIdentity(\n    DIDMethodName.Peer,\n    secretPinNumber,\n    PeerGenerationMethod.Method2,\n  );\n\n  const data = (await createEvent) as ServiceResponse<{ did: string }>;\n  return data.payload.did;\n};\n```\n\nOnce you have the `senderDid`, you can send messages using the `MessageExchangeService`.\n\n### Using the `MessageExchangeService`\n\nThe `MessageExchangeService` is designed to work seamlessly with an event\nbus architecture. Here's how to send a message from a sender to a recipient:\n\n```ts\nimport { MessageExchangeService } from '@adorsys-gis/message-exchange';\nimport { MessageExchangeEvent } from '@adorsys-gis/message-exchange';\n\nconst messageExchangeService = new MessageExchangeService(\n  eventBus,\n  secretPinNumber,\n);\n\n// Listen on the MessageExchangeEvent.RouteForwardMessages event\n\nmessageExchangeService.routeForwardMessage(message, recipientDid, senderDid);\n\n// Wait for an acknowledgement on MessageExchangeEvent.RouteForwardMessages\n```\n\n### Using the `MessageRouter` Interface\n\nIf your application does not use an event bus, you can interact directly with\nthe `MessageRouter` interface:\n\n```ts\nimport { MessageRouter } from '@adorsys-gis/message-exchange';\n\nconst messageRouter = new MessageRouter(\n  didRepository,\n  messageRepository,\n  secretPinNumber,\n);\n\nconst sentMessage = await messageRouter.routeForwardMessage(\n  message,\n  recipientDid,\n  senderDid,\n);\n```\n\n### Additional Help\n\nFor more examples and detailed scenarios, consider referring to the test\ncases in the project.\n","readmeFilename":"README.md"}