@sovrahq/waci 3.4.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 (124) hide show
  1. package/.eslintignore +2 -0
  2. package/.eslintrc.js +21 -0
  3. package/.prettierrc +4 -0
  4. package/LICENSE +201 -0
  5. package/dist/callbacks/index.d.ts +108 -0
  6. package/dist/callbacks/index.js +9 -0
  7. package/dist/callbacks/index.js.map +1 -0
  8. package/dist/constants/index.d.ts +1 -0
  9. package/dist/constants/index.js +5 -0
  10. package/dist/constants/index.js.map +1 -0
  11. package/dist/handlers/common/problem-report.handler.d.ts +4 -0
  12. package/dist/handlers/common/problem-report.handler.js +72 -0
  13. package/dist/handlers/common/problem-report.handler.js.map +1 -0
  14. package/dist/handlers/common/step-2-oob-invitation.handler.d.ts +4 -0
  15. package/dist/handlers/common/step-2-oob-invitation.handler.js +93 -0
  16. package/dist/handlers/common/step-2-oob-invitation.handler.js.map +1 -0
  17. package/dist/handlers/decorators/register-handler.decorator.d.ts +2 -0
  18. package/dist/handlers/decorators/register-handler.decorator.js +13 -0
  19. package/dist/handlers/decorators/register-handler.decorator.js.map +1 -0
  20. package/dist/handlers/index.d.ts +6 -0
  21. package/dist/handlers/index.js +11 -0
  22. package/dist/handlers/index.js.map +1 -0
  23. package/dist/handlers/issuance/step-3-propose-credential.handler.d.ts +32 -0
  24. package/dist/handlers/issuance/step-3-propose-credential.handler.js +180 -0
  25. package/dist/handlers/issuance/step-3-propose-credential.handler.js.map +1 -0
  26. package/dist/handlers/issuance/step-4-1-offer-credential-proceed.handler.d.ts +5 -0
  27. package/dist/handlers/issuance/step-4-1-offer-credential-proceed.handler.js +152 -0
  28. package/dist/handlers/issuance/step-4-1-offer-credential-proceed.handler.js.map +1 -0
  29. package/dist/handlers/issuance/step-4-offer-credential.handler.d.ts +5 -0
  30. package/dist/handlers/issuance/step-4-offer-credential.handler.js +169 -0
  31. package/dist/handlers/issuance/step-4-offer-credential.handler.js.map +1 -0
  32. package/dist/handlers/issuance/step-5-request-credential.handler.d.ts +4 -0
  33. package/dist/handlers/issuance/step-5-request-credential.handler.js +275 -0
  34. package/dist/handlers/issuance/step-5-request-credential.handler.js.map +1 -0
  35. package/dist/handlers/issuance/step-6-issue-credential.handler.d.ts +4 -0
  36. package/dist/handlers/issuance/step-6-issue-credential.handler.js +106 -0
  37. package/dist/handlers/issuance/step-6-issue-credential.handler.js.map +1 -0
  38. package/dist/handlers/issuance/step-7-ack-message.handler.d.ts +4 -0
  39. package/dist/handlers/issuance/step-7-ack-message.handler.js +78 -0
  40. package/dist/handlers/issuance/step-7-ack-message.handler.js.map +1 -0
  41. package/dist/handlers/presentation/step-3-propose-presentation.handler.d.ts +5 -0
  42. package/dist/handlers/presentation/step-3-propose-presentation.handler.js +107 -0
  43. package/dist/handlers/presentation/step-3-propose-presentation.handler.js.map +1 -0
  44. package/dist/handlers/presentation/step-4-1-presentation-proceed.handler.d.ts +5 -0
  45. package/dist/handlers/presentation/step-4-1-presentation-proceed.handler.js +130 -0
  46. package/dist/handlers/presentation/step-4-1-presentation-proceed.handler.js.map +1 -0
  47. package/dist/handlers/presentation/step-4-request-presentation.handler.d.ts +5 -0
  48. package/dist/handlers/presentation/step-4-request-presentation.handler.js +151 -0
  49. package/dist/handlers/presentation/step-4-request-presentation.handler.js.map +1 -0
  50. package/dist/handlers/presentation/step-5-present-proof.handler.d.ts +4 -0
  51. package/dist/handlers/presentation/step-5-present-proof.handler.js +211 -0
  52. package/dist/handlers/presentation/step-5-present-proof.handler.js.map +1 -0
  53. package/dist/handlers/presentation/step-6-ack-message.handler.d.ts +4 -0
  54. package/dist/handlers/presentation/step-6-ack-message.handler.js +72 -0
  55. package/dist/handlers/presentation/step-6-ack-message.handler.js.map +1 -0
  56. package/dist/index.d.ts +17 -0
  57. package/dist/index.js +37 -0
  58. package/dist/index.js.map +1 -0
  59. package/dist/services/waci-interpreter.d.ts +17 -0
  60. package/dist/services/waci-interpreter.js +222 -0
  61. package/dist/services/waci-interpreter.js.map +1 -0
  62. package/dist/types/actor.d.ts +5 -0
  63. package/dist/types/actor.js +10 -0
  64. package/dist/types/actor.js.map +1 -0
  65. package/dist/types/credential-application.d.ts +36 -0
  66. package/dist/types/credential-application.js +3 -0
  67. package/dist/types/credential-application.js.map +1 -0
  68. package/dist/types/credential-manifest.d.ts +173 -0
  69. package/dist/types/credential-manifest.js +3 -0
  70. package/dist/types/credential-manifest.js.map +1 -0
  71. package/dist/types/index.d.ts +4 -0
  72. package/dist/types/index.js +21 -0
  73. package/dist/types/index.js.map +1 -0
  74. package/dist/types/problem-report.d.ts +13 -0
  75. package/dist/types/problem-report.js +18 -0
  76. package/dist/types/problem-report.js.map +1 -0
  77. package/dist/types/waci-message.d.ts +106 -0
  78. package/dist/types/waci-message.js +106 -0
  79. package/dist/types/waci-message.js.map +1 -0
  80. package/dist/utils/erros.d.ts +15 -0
  81. package/dist/utils/erros.js +42 -0
  82. package/dist/utils/erros.js.map +1 -0
  83. package/dist/utils/index.d.ts +22 -0
  84. package/dist/utils/index.js +356 -0
  85. package/dist/utils/index.js.map +1 -0
  86. package/jest.config.json +17 -0
  87. package/package.json +39 -0
  88. package/readme.md +1 -0
  89. package/src/callbacks/index.ts +75 -0
  90. package/src/constants/index.ts +1 -0
  91. package/src/handlers/common/problem-report.handler.ts +15 -0
  92. package/src/handlers/common/step-2-oob-invitation.handler.ts +45 -0
  93. package/src/handlers/decorators/register-handler.decorator.ts +10 -0
  94. package/src/handlers/index.ts +7 -0
  95. package/src/handlers/issuance/step-3-propose-credential.handler.ts +186 -0
  96. package/src/handlers/issuance/step-4-1-offer-credential-proceed.handler.ts +129 -0
  97. package/src/handlers/issuance/step-4-offer-credential.handler.ts +137 -0
  98. package/src/handlers/issuance/step-5-request-credential.handler.ts +205 -0
  99. package/src/handlers/issuance/step-6-issue-credential.handler.ts +63 -0
  100. package/src/handlers/issuance/step-7-ack-message.handler.ts +21 -0
  101. package/src/handlers/presentation/step-3-propose-presentation.handler.ts +67 -0
  102. package/src/handlers/presentation/step-4-1-presentation-proceed.handler.ts +100 -0
  103. package/src/handlers/presentation/step-4-request-presentation.handler.ts +115 -0
  104. package/src/handlers/presentation/step-5-present-proof.handler.ts +159 -0
  105. package/src/handlers/presentation/step-6-ack-message.handler.ts +15 -0
  106. package/src/index.ts +18 -0
  107. package/src/services/waci-interpreter.ts +161 -0
  108. package/src/types/actor.ts +5 -0
  109. package/src/types/credential-application.ts +38 -0
  110. package/src/types/credential-manifest.ts +184 -0
  111. package/src/types/index.ts +4 -0
  112. package/src/types/problem-report.ts +29 -0
  113. package/src/types/waci-message.ts +148 -0
  114. package/src/utils/erros.ts +21 -0
  115. package/src/utils/index.ts +272 -0
  116. package/test/handlers/issuance/step-3-propose-credential.handler.spec.ts +43 -0
  117. package/test/handlers/issuance/step-4-offer-credential.handler.spec.ts +53 -0
  118. package/test/handlers/issuance/step-5-request-credential.handler.spec.ts +102 -0
  119. package/test/handlers/presentation/step-5-present-proof.handler.spec.ts +142 -0
  120. package/test/handlers/shared/step-2-oob-invitation.handler.spec.ts +55 -0
  121. package/test/stubs/index.ts +842 -0
  122. package/test/waci-interpreter.spec.ts +113 -0
  123. package/tsconfig.build.json +9 -0
  124. package/tsconfig.json +20 -0
@@ -0,0 +1,113 @@
1
+ import {
2
+ WACIInterpreter,
3
+ WACIResponse,
4
+ WACIMessage,
5
+ WACIMessageResponseType,
6
+ WACIMessageType,
7
+ Actor,
8
+ } from '../src';
9
+ import { getObjectValues } from '../src/utils';
10
+ import {
11
+ credentialManifestParamsStub,
12
+ offerCredentialMessageStub1,
13
+ } from './stubs';
14
+ import { OfferCredentialMessageParams } from '../src/handlers/issuance/step-3-propose-credential.handler';
15
+
16
+ jest.mock('../src/utils', () => ({
17
+ extractSuffixFromUUID:
18
+ jest.requireActual('../src/utils').extractSuffixFromUUID,
19
+ getObjectValues: jest.requireActual('../src/utils').getObjectValues,
20
+ createUUID: (): string => 'f137e0db-db7b-4776-9530-83c808a34a42',
21
+ }));
22
+
23
+ describe('WACIInterpreter', () => {
24
+ let waciInterpreter: WACIInterpreter;
25
+ beforeEach(() => {
26
+ waciInterpreter = new WACIInterpreter();
27
+ });
28
+ describe('isWACIMessage method', () => {
29
+ it('should return true when checking a valid message type', () => {
30
+ getObjectValues(WACIMessageType).forEach((type) =>
31
+ expect(waciInterpreter.isWACIMessage({ type })).toBe(true),
32
+ );
33
+ });
34
+
35
+ it('should return false when checking an unknown message type', () => {
36
+ expect(waciInterpreter.isWACIMessage({ type: '' })).toBe(false);
37
+ expect(waciInterpreter.isWACIMessage({ type: 'asdasd' })).toBe(false);
38
+ expect(waciInterpreter.isWACIMessage({ type: null })).toBe(false);
39
+ expect(waciInterpreter.isWACIMessage({ type: undefined })).toBe(false);
40
+ expect(waciInterpreter.isWACIMessage({ type: {} as any })).toBe(false);
41
+ expect(waciInterpreter.isWACIMessage(null)).toBe(false);
42
+ expect(waciInterpreter.isWACIMessage(undefined)).toBe(false);
43
+ });
44
+ });
45
+
46
+ describe('setUpFor method', () => {
47
+ it('should add enabled actor on set up', () => {
48
+ const { enabledActors } = waciInterpreter as any;
49
+ waciInterpreter.setUpFor<Actor.Holder>(null, Actor.Holder);
50
+ expect(enabledActors).toMatchObject([Actor.Holder]);
51
+ waciInterpreter.setUpFor<Actor.Issuer>(null, Actor.Issuer);
52
+ expect(enabledActors).toMatchObject([Actor.Holder, Actor.Issuer]);
53
+ waciInterpreter.setUpFor<Actor.Verifier>(null, Actor.Verifier);
54
+ expect(enabledActors).toMatchObject([
55
+ Actor.Holder,
56
+ Actor.Issuer,
57
+ Actor.Verifier,
58
+ ]);
59
+ });
60
+
61
+ it('should be able to chain subsequent calls', () => {
62
+ const { enabledActors } = waciInterpreter as any;
63
+ waciInterpreter
64
+ .setUpFor<Actor.Holder>(null, Actor.Holder)
65
+ .setUpFor<Actor.Issuer>(null, Actor.Issuer)
66
+ .setUpFor<Actor.Verifier>(null, Actor.Verifier);
67
+ expect(enabledActors).toMatchObject([
68
+ Actor.Holder,
69
+ Actor.Issuer,
70
+ Actor.Verifier,
71
+ ]);
72
+ });
73
+ });
74
+
75
+ describe('processMessage method', () => {
76
+ const message: WACIMessage = {
77
+ type: WACIMessageType.ProposeCredential,
78
+ id: 'f137e0db-db7b-4776-9530-83c808a34a42',
79
+ from: 'did:example:holder',
80
+ pthid: 'f137e0db-db7b-4776-9530-83c808a34a42',
81
+ to: ['did:example:issuer'],
82
+ };
83
+
84
+ it('should throw an error when processing a message with no handlers associated', async () => {
85
+ await expect(() =>
86
+ waciInterpreter.processMessage([message]),
87
+ ).rejects.toThrow();
88
+ });
89
+
90
+ it('should return an offer credential message when processing a propose credential message', async () => {
91
+ waciInterpreter.setUpFor<Actor.Issuer>(
92
+ {
93
+ signCredential: null,
94
+ verifyCredential: null,
95
+ handleIssuanceAck: null,
96
+ verifyPresentation: null,
97
+ getCredentialManifest:
98
+ async (): Promise<OfferCredentialMessageParams> =>
99
+ credentialManifestParamsStub,
100
+ },
101
+ Actor.Issuer,
102
+ );
103
+ const expectedResponse: WACIResponse = {
104
+ responseType: WACIMessageResponseType.ReplyThread,
105
+ message: offerCredentialMessageStub1 as any,
106
+ target: 'did:example:holder',
107
+ };
108
+
109
+ const response = await waciInterpreter.processMessage([message]);
110
+ expect(response).toEqual(expectedResponse);
111
+ });
112
+ });
113
+ });
@@ -0,0 +1,9 @@
1
+ {
2
+ "extends": "./tsconfig.json",
3
+ "exclude": [
4
+ "node_modules",
5
+ "test",
6
+ "dist",
7
+ "**/*spec.ts"
8
+ ]
9
+ }
package/tsconfig.json ADDED
@@ -0,0 +1,20 @@
1
+ {
2
+ "compilerOptions": {
3
+ "target": "es5",
4
+ "lib": [
5
+ "es6"
6
+ ],
7
+ "types": [
8
+ "reflect-metadata",
9
+ "node",
10
+ "jest"
11
+ ],
12
+ "outDir": "dist",
13
+ "module": "commonjs",
14
+ "moduleResolution": "node",
15
+ "sourceMap": true,
16
+ "declaration": true,
17
+ "experimentalDecorators": true,
18
+ "emitDecoratorMetadata": true
19
+ }
20
+ }