@sphereon/ssi-sdk-ext.identifier-resolution 0.24.1-unstable.75

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 (25) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +54 -0
  3. package/dist/agent/IdentifierResolution.d.ts +23 -0
  4. package/dist/agent/IdentifierResolution.d.ts.map +1 -0
  5. package/dist/agent/IdentifierResolution.js +66 -0
  6. package/dist/agent/IdentifierResolution.js.map +1 -0
  7. package/dist/functions/index.d.ts +13 -0
  8. package/dist/functions/index.d.ts.map +1 -0
  9. package/dist/functions/index.js +241 -0
  10. package/dist/functions/index.js.map +1 -0
  11. package/dist/index.d.ts +12 -0
  12. package/dist/index.d.ts.map +1 -0
  13. package/dist/index.js +30 -0
  14. package/dist/index.js.map +1 -0
  15. package/dist/tsdoc-metadata.json +11 -0
  16. package/dist/types/IIdentifierResolution.d.ts +170 -0
  17. package/dist/types/IIdentifierResolution.d.ts.map +1 -0
  18. package/dist/types/IIdentifierResolution.js +98 -0
  19. package/dist/types/IIdentifierResolution.js.map +1 -0
  20. package/package.json +66 -0
  21. package/plugin.schema.json +805 -0
  22. package/src/agent/IdentifierResolution.ts +69 -0
  23. package/src/functions/index.ts +267 -0
  24. package/src/index.ts +11 -0
  25. package/src/types/IIdentifierResolution.ts +297 -0
package/plugin.schema.json ADDED
@@ -0,0 +1,805 @@
1
+ {
2
+ "IIdentifierResolution": {
3
+ "components": {
4
+ "schemas": {
5
+ "ExternalIdentifierOpts": {
6
+ "anyOf": [
7
+ {
8
+ "type": "object",
9
+ "properties": {
10
+ "method": {
11
+ "type": "string",
12
+ "const": "jwk"
13
+ },
14
+ "identifier": {
15
+ "$ref": "#/components/schemas/ExternalIdentifierType"
16
+ }
17
+ },
18
+ "required": [
19
+ "identifier"
20
+ ]
21
+ },
22
+ {
23
+ "type": "object",
24
+ "properties": {
25
+ "method": {
26
+ "type": "string",
27
+ "const": "x5c"
28
+ },
29
+ "identifier": {
30
+ "$ref": "#/components/schemas/ExternalIdentifierType"
31
+ },
32
+ "verify": {
33
+ "type": "boolean"
34
+ },
35
+ "verificationTime": {
36
+ "type": "string",
37
+ "format": "date-time"
38
+ },
39
+ "trustAnchors": {
40
+ "type": "array",
41
+ "items": {
42
+ "type": "string"
43
+ }
44
+ }
45
+ },
46
+ "required": [
47
+ "identifier",
48
+ "verify"
49
+ ]
50
+ },
51
+ {
52
+ "type": "object",
53
+ "properties": {
54
+ "method": {
55
+ "type": "string",
56
+ "const": "did"
57
+ },
58
+ "identifier": {
59
+ "$ref": "#/components/schemas/ExternalIdentifierType"
60
+ },
61
+ "noVerificationMethodFallback": {
62
+ "type": "boolean"
63
+ },
64
+ "vmRelationship": {
65
+ "$ref": "#/components/schemas/DIDDocumentSection"
66
+ },
67
+ "localResolution": {
68
+ "type": "boolean"
69
+ },
70
+ "uniresolverResolution": {
71
+ "type": "boolean"
72
+ },
73
+ "resolverResolution": {
74
+ "type": "boolean"
75
+ }
76
+ },
77
+ "required": [
78
+ "identifier"
79
+ ]
80
+ },
81
+ {
82
+ "type": "object",
83
+ "properties": {
84
+ "method": {
85
+ "type": "string",
86
+ "const": "kid"
87
+ },
88
+ "identifier": {
89
+ "$ref": "#/components/schemas/ExternalIdentifierType"
90
+ }
91
+ },
92
+ "required": [
93
+ "identifier"
94
+ ]
95
+ }
96
+ ]
97
+ },
98
+ "ExternalIdentifierType": {
99
+ "anyOf": [
100
+ {
101
+ "type": "string"
102
+ },
103
+ {
104
+ "type": "array",
105
+ "items": {
106
+ "type": "string"
107
+ }
108
+ },
109
+ {
110
+ "$ref": "#/components/schemas/JWK"
111
+ }
112
+ ],
113
+ "description": "Use whenever we need to resolve an external identifier. We can pass in kids, DIDs, and x5chains\n\nThe functions below can be used to check the type, and they also provide the proper runtime types"
114
+ },
115
+ "JWK": {
116
+ "type": "object",
117
+ "properties": {
118
+ "kty": {
119
+ "type": "string"
120
+ },
121
+ "alg": {
122
+ "type": "string"
123
+ },
124
+ "crv": {
125
+ "type": "string"
126
+ },
127
+ "d": {
128
+ "type": "string"
129
+ },
130
+ "dp": {
131
+ "type": "string"
132
+ },
133
+ "dq": {
134
+ "type": "string"
135
+ },
136
+ "e": {
137
+ "type": "string"
138
+ },
139
+ "ext": {
140
+ "type": "boolean"
141
+ },
142
+ "k": {
143
+ "type": "string"
144
+ },
145
+ "key_ops": {
146
+ "type": "array",
147
+ "items": {
148
+ "type": "string"
149
+ }
150
+ },
151
+ "kid": {
152
+ "type": "string"
153
+ },
154
+ "n": {
155
+ "type": "string"
156
+ },
157
+ "oth": {
158
+ "type": "array",
159
+ "items": {
160
+ "type": "object",
161
+ "properties": {
162
+ "d": {
163
+ "type": "string"
164
+ },
165
+ "r": {
166
+ "type": "string"
167
+ },
168
+ "t": {
169
+ "type": "string"
170
+ }
171
+ }
172
+ }
173
+ },
174
+ "p": {
175
+ "type": "string"
176
+ },
177
+ "q": {
178
+ "type": "string"
179
+ },
180
+ "qi": {
181
+ "type": "string"
182
+ },
183
+ "use": {
184
+ "type": "string"
185
+ },
186
+ "x": {
187
+ "type": "string"
188
+ },
189
+ "y": {
190
+ "type": "string"
191
+ },
192
+ "x5c": {
193
+ "type": "array",
194
+ "items": {
195
+ "type": "string"
196
+ },
197
+ "description": "JWK \"x5c\" (X.509 Certificate Chain) Parameter."
198
+ },
199
+ "x5t": {
200
+ "type": "string",
201
+ "description": "JWK \"x5t\" (X.509 Certificate SHA-1 Thumbprint) Parameter."
202
+ },
203
+ "x5t#S256": {
204
+ "type": "string",
205
+ "description": "\"x5t#S256\" (X.509 Certificate SHA-256 Thumbprint) Parameter."
206
+ },
207
+ "x5u": {
208
+ "type": "string",
209
+ "description": "JWK \"x5u\" (X.509 URL) Parameter."
210
+ }
211
+ },
212
+ "required": [
213
+ "kty"
214
+ ],
215
+ "additionalProperties": {}
216
+ },
217
+ "DIDDocumentSection": {
218
+ "type": "string",
219
+ "enum": [
220
+ "verificationMethod",
221
+ "publicKey",
222
+ "service",
223
+ "authentication",
224
+ "assertionMethod",
225
+ "keyAgreement",
226
+ "capabilityInvocation",
227
+ "capabilityDelegation"
228
+ ],
229
+ "description": "Refers to a section of a DID document. Either the list of verification methods or services or one of the verification relationships.\n\nSee {@link https://www.w3.org/TR/did-core/#verification-relationships | verification relationships }"
230
+ },
231
+ "ManagedIdentifierOpts": {
232
+ "anyOf": [
233
+ {
234
+ "type": "object",
235
+ "properties": {
236
+ "method": {
237
+ "type": "string",
238
+ "const": "jwk"
239
+ },
240
+ "identifier": {
241
+ "$ref": "#/components/schemas/ManagedIdentifierType"
242
+ },
243
+ "kmsKeyRef": {
244
+ "type": "string"
245
+ }
246
+ },
247
+ "required": [
248
+ "identifier"
249
+ ]
250
+ },
251
+ {
252
+ "type": "object",
253
+ "properties": {
254
+ "method": {
255
+ "type": "string",
256
+ "const": "x5c"
257
+ },
258
+ "identifier": {
259
+ "$ref": "#/components/schemas/ManagedIdentifierType"
260
+ },
261
+ "kmsKeyRef": {
262
+ "type": "string"
263
+ }
264
+ },
265
+ "required": [
266
+ "identifier"
267
+ ]
268
+ },
269
+ {
270
+ "type": "object",
271
+ "properties": {
272
+ "method": {
273
+ "type": "string",
274
+ "const": "did"
275
+ },
276
+ "identifier": {
277
+ "$ref": "#/components/schemas/ManagedIdentifierType"
278
+ },
279
+ "kmsKeyRef": {
280
+ "type": "string"
281
+ },
282
+ "keyType": {
283
+ "$ref": "#/components/schemas/TKeyType"
284
+ },
285
+ "offlineWhenNoDIDRegistered": {
286
+ "type": "boolean"
287
+ },
288
+ "noVerificationMethodFallback": {
289
+ "type": "boolean"
290
+ },
291
+ "controllerKey": {
292
+ "type": "boolean"
293
+ },
294
+ "vmRelationship": {
295
+ "$ref": "#/components/schemas/DIDDocumentSection"
296
+ }
297
+ },
298
+ "required": [
299
+ "identifier"
300
+ ]
301
+ },
302
+ {
303
+ "type": "object",
304
+ "properties": {
305
+ "method": {
306
+ "type": "string",
307
+ "const": "kid"
308
+ },
309
+ "identifier": {
310
+ "$ref": "#/components/schemas/ManagedIdentifierType"
311
+ },
312
+ "kmsKeyRef": {
313
+ "type": "string"
314
+ }
315
+ },
316
+ "required": [
317
+ "identifier"
318
+ ]
319
+ }
320
+ ]
321
+ },
322
+ "ManagedIdentifierType": {
323
+ "anyOf": [
324
+ {
325
+ "$ref": "#/components/schemas/IIdentifier"
326
+ },
327
+ {
328
+ "type": "string"
329
+ },
330
+ {
331
+ "type": "array",
332
+ "items": {
333
+ "type": "string"
334
+ }
335
+ },
336
+ {
337
+ "$ref": "#/components/schemas/JWK"
338
+ }
339
+ ],
340
+ "description": "Use whenever we need to pass in an identifier. We can pass in kids, DIDs, IIdentifier objects and x5chains\n\nThe functions below can be used to check the type, and they also provide the proper runtime types"
341
+ },
342
+ "IIdentifier": {
343
+ "type": "object",
344
+ "properties": {
345
+ "did": {
346
+ "type": "string",
347
+ "description": "Decentralized identifier"
348
+ },
349
+ "alias": {
350
+ "type": "string",
351
+ "description": "Optional. Identifier alias. Can be used to reference an object in an external system"
352
+ },
353
+ "provider": {
354
+ "type": "string",
355
+ "description": "Identifier provider name"
356
+ },
357
+ "controllerKeyId": {
358
+ "type": "string",
359
+ "description": "Controller key id"
360
+ },
361
+ "keys": {
362
+ "type": "array",
363
+ "items": {
364
+ "$ref": "#/components/schemas/IKey"
365
+ },
366
+ "description": "Array of managed keys"
367
+ },
368
+ "services": {
369
+ "type": "array",
370
+ "items": {
371
+ "$ref": "#/components/schemas/IService"
372
+ },
373
+ "description": "Array of services"
374
+ }
375
+ },
376
+ "required": [
377
+ "did",
378
+ "provider",
379
+ "keys",
380
+ "services"
381
+ ],
382
+ "description": "Identifier interface"
383
+ },
384
+ "IKey": {
385
+ "type": "object",
386
+ "properties": {
387
+ "kid": {
388
+ "type": "string",
389
+ "description": "Key ID"
390
+ },
391
+ "kms": {
392
+ "type": "string",
393
+ "description": "Key Management System"
394
+ },
395
+ "type": {
396
+ "$ref": "#/components/schemas/TKeyType",
397
+ "description": "Key type"
398
+ },
399
+ "publicKeyHex": {
400
+ "type": "string",
401
+ "description": "Public key"
402
+ },
403
+ "privateKeyHex": {
404
+ "type": "string",
405
+ "description": "Optional. Private key"
406
+ },
407
+ "meta": {
408
+ "anyOf": [
409
+ {
410
+ "$ref": "#/components/schemas/KeyMetadata"
411
+ },
412
+ {
413
+ "type": "null"
414
+ }
415
+ ],
416
+ "description": "Optional. Key metadata. This should be used to determine which algorithms are supported."
417
+ }
418
+ },
419
+ "required": [
420
+ "kid",
421
+ "kms",
422
+ "type",
423
+ "publicKeyHex"
424
+ ],
425
+ "description": "Cryptographic key"
426
+ },
427
+ "TKeyType": {
428
+ "type": "string",
429
+ "enum": [
430
+ "Ed25519",
431
+ "Secp256k1",
432
+ "Secp256r1",
433
+ "X25519",
434
+ "Bls12381G1",
435
+ "Bls12381G2",
436
+ "RSA"
437
+ ],
438
+ "description": "Cryptographic key type."
439
+ },
440
+ "KeyMetadata": {
441
+ "type": "object",
442
+ "properties": {
443
+ "algorithms": {
444
+ "type": "array",
445
+ "items": {
446
+ "type": "string"
447
+ }
448
+ }
449
+ },
450
+ "description": "This encapsulates data about a key.\n\nImplementations of {@link @veramo/key-manager#AbstractKeyManagementSystem | AbstractKeyManagementSystem } should populate this object, for each key, with the algorithms that can be performed using it.\n\nThis can also be used to add various tags to the keys under management."
451
+ },
452
+ "IService": {
453
+ "type": "object",
454
+ "properties": {
455
+ "id": {
456
+ "type": "string",
457
+ "description": "ID"
458
+ },
459
+ "type": {
460
+ "type": "string",
461
+ "description": "Service type"
462
+ },
463
+ "serviceEndpoint": {
464
+ "anyOf": [
465
+ {
466
+ "$ref": "#/components/schemas/IServiceEndpoint"
467
+ },
468
+ {
469
+ "type": "array",
470
+ "items": {
471
+ "$ref": "#/components/schemas/IServiceEndpoint"
472
+ }
473
+ }
474
+ ],
475
+ "description": "Endpoint URL"
476
+ },
477
+ "description": {
478
+ "type": "string",
479
+ "description": "Optional. Description"
480
+ }
481
+ },
482
+ "required": [
483
+ "id",
484
+ "type",
485
+ "serviceEndpoint"
486
+ ],
487
+ "description": "Identifier service"
488
+ },
489
+ "IServiceEndpoint": {
490
+ "anyOf": [
491
+ {
492
+ "type": "string"
493
+ },
494
+ {
495
+ "type": "object"
496
+ }
497
+ ],
498
+ "description": "Represents a service endpoint URL or a map of URLs"
499
+ },
500
+ "ManagedIdentifierResult": {
501
+ "anyOf": [
502
+ {
503
+ "$ref": "#/components/schemas/ManagedIdentifierX5cResult"
504
+ },
505
+ {
506
+ "$ref": "#/components/schemas/ManagedIdentifierDidResult"
507
+ },
508
+ {
509
+ "$ref": "#/components/schemas/ManagedIdentifierJwkResult"
510
+ },
511
+ {
512
+ "$ref": "#/components/schemas/ManagedIdentifierKidResult"
513
+ }
514
+ ]
515
+ },
516
+ "ManagedIdentifierX5cResult": {
517
+ "type": "object",
518
+ "properties": {
519
+ "jwk": {
520
+ "$ref": "#/components/schemas/JWK"
521
+ },
522
+ "jwkThumbprint": {
523
+ "type": "string"
524
+ },
525
+ "kmsKeyRef": {
526
+ "type": "string"
527
+ },
528
+ "method": {
529
+ "type": "string",
530
+ "const": "x5c"
531
+ },
532
+ "key": {
533
+ "$ref": "#/components/schemas/IKey"
534
+ },
535
+ "x5c": {
536
+ "type": "array",
537
+ "items": {
538
+ "type": "string"
539
+ }
540
+ },
541
+ "certificate": {}
542
+ },
543
+ "required": [
544
+ "certificate",
545
+ "jwk",
546
+ "jwkThumbprint",
547
+ "key",
548
+ "kmsKeyRef",
549
+ "method",
550
+ "x5c"
551
+ ]
552
+ },
553
+ "ManagedIdentifierDidResult": {
554
+ "type": "object",
555
+ "properties": {
556
+ "jwk": {
557
+ "$ref": "#/components/schemas/JWK"
558
+ },
559
+ "jwkThumbprint": {
560
+ "type": "string"
561
+ },
562
+ "kmsKeyRef": {
563
+ "type": "string"
564
+ },
565
+ "method": {
566
+ "type": "string",
567
+ "const": "did"
568
+ },
569
+ "key": {
570
+ "$ref": "#/components/schemas/IKey"
571
+ },
572
+ "identifier": {
573
+ "$ref": "#/components/schemas/IIdentifier"
574
+ },
575
+ "did": {
576
+ "type": "string"
577
+ },
578
+ "keys": {
579
+ "type": "array",
580
+ "items": {
581
+ "$ref": "#/components/schemas/IKey"
582
+ }
583
+ },
584
+ "verificationMethodSection": {
585
+ "$ref": "#/components/schemas/DIDDocumentSection"
586
+ },
587
+ "controllerKeyId": {
588
+ "type": "string"
589
+ }
590
+ },
591
+ "required": [
592
+ "controllerKeyId",
593
+ "did",
594
+ "identifier",
595
+ "jwk",
596
+ "jwkThumbprint",
597
+ "key",
598
+ "keys",
599
+ "kmsKeyRef",
600
+ "method"
601
+ ]
602
+ },
603
+ "ManagedIdentifierJwkResult": {
604
+ "type": "object",
605
+ "properties": {
606
+ "jwk": {
607
+ "$ref": "#/components/schemas/JWK"
608
+ },
609
+ "jwkThumbprint": {
610
+ "type": "string"
611
+ },
612
+ "kmsKeyRef": {
613
+ "type": "string"
614
+ },
615
+ "method": {
616
+ "type": "string",
617
+ "const": "jwk"
618
+ },
619
+ "key": {
620
+ "$ref": "#/components/schemas/IKey"
621
+ }
622
+ },
623
+ "required": [
624
+ "jwk",
625
+ "jwkThumbprint",
626
+ "key",
627
+ "kmsKeyRef",
628
+ "method"
629
+ ]
630
+ },
631
+ "ManagedIdentifierKidResult": {
632
+ "type": "object",
633
+ "properties": {
634
+ "jwk": {
635
+ "$ref": "#/components/schemas/JWK"
636
+ },
637
+ "jwkThumbprint": {
638
+ "type": "string"
639
+ },
640
+ "kmsKeyRef": {
641
+ "type": "string"
642
+ },
643
+ "method": {
644
+ "type": "string",
645
+ "const": "kid"
646
+ },
647
+ "key": {
648
+ "$ref": "#/components/schemas/IKey"
649
+ }
650
+ },
651
+ "required": [
652
+ "jwk",
653
+ "jwkThumbprint",
654
+ "key",
655
+ "kmsKeyRef",
656
+ "method"
657
+ ]
658
+ },
659
+ "ManagedIdentifierDidOpts": {
660
+ "type": "object",
661
+ "properties": {
662
+ "method": {
663
+ "type": "string",
664
+ "const": "did"
665
+ },
666
+ "identifier": {
667
+ "$ref": "#/components/schemas/ManagedIdentifierType"
668
+ },
669
+ "keyType": {
670
+ "$ref": "#/components/schemas/TKeyType"
671
+ },
672
+ "offlineWhenNoDIDRegistered": {
673
+ "type": "boolean"
674
+ },
675
+ "noVerificationMethodFallback": {
676
+ "type": "boolean"
677
+ },
678
+ "controllerKey": {
679
+ "type": "boolean"
680
+ },
681
+ "vmRelationship": {
682
+ "$ref": "#/components/schemas/DIDDocumentSection"
683
+ },
684
+ "kmsKeyRef": {
685
+ "type": "string"
686
+ }
687
+ },
688
+ "required": [
689
+ "identifier"
690
+ ]
691
+ },
692
+ "ManagedIdentifierJwkOpts": {
693
+ "type": "object",
694
+ "properties": {
695
+ "method": {
696
+ "type": "string",
697
+ "const": "jwk"
698
+ },
699
+ "identifier": {
700
+ "$ref": "#/components/schemas/ManagedIdentifierType"
701
+ },
702
+ "kmsKeyRef": {
703
+ "type": "string"
704
+ }
705
+ },
706
+ "required": [
707
+ "identifier"
708
+ ]
709
+ },
710
+ "ManagedIdentifierKidOpts": {
711
+ "type": "object",
712
+ "properties": {
713
+ "method": {
714
+ "type": "string",
715
+ "const": "kid"
716
+ },
717
+ "identifier": {
718
+ "$ref": "#/components/schemas/ManagedIdentifierType"
719
+ },
720
+ "kmsKeyRef": {
721
+ "type": "string"
722
+ }
723
+ },
724
+ "required": [
725
+ "identifier"
726
+ ]
727
+ },
728
+ "ManagedIdentifierX5cOpts": {
729
+ "type": "object",
730
+ "properties": {
731
+ "method": {
732
+ "type": "string",
733
+ "const": "x5c"
734
+ },
735
+ "identifier": {
736
+ "$ref": "#/components/schemas/ManagedIdentifierType"
737
+ },
738
+ "kmsKeyRef": {
739
+ "type": "string"
740
+ }
741
+ },
742
+ "required": [
743
+ "identifier"
744
+ ]
745
+ }
746
+ },
747
+ "methods": {
748
+ "identifierExternalResolve": {
749
+ "description": "",
750
+ "arguments": {
751
+ "$ref": "#/components/schemas/ExternalIdentifierOpts"
752
+ },
753
+ "returnType": {
754
+ "type": "object"
755
+ }
756
+ },
757
+ "identifierManagedGet": {
758
+ "description": "",
759
+ "arguments": {
760
+ "$ref": "#/components/schemas/ManagedIdentifierOpts"
761
+ },
762
+ "returnType": {
763
+ "$ref": "#/components/schemas/ManagedIdentifierResult"
764
+ }
765
+ },
766
+ "identifierManagedGetByDid": {
767
+ "description": "",
768
+ "arguments": {
769
+ "$ref": "#/components/schemas/ManagedIdentifierDidOpts"
770
+ },
771
+ "returnType": {
772
+ "$ref": "#/components/schemas/ManagedIdentifierDidResult"
773
+ }
774
+ },
775
+ "identifierManagedGetByJwk": {
776
+ "description": "",
777
+ "arguments": {
778
+ "$ref": "#/components/schemas/ManagedIdentifierJwkOpts"
779
+ },
780
+ "returnType": {
781
+ "$ref": "#/components/schemas/ManagedIdentifierJwkResult"
782
+ }
783
+ },
784
+ "identifierManagedGetByKid": {
785
+ "description": "",
786
+ "arguments": {
787
+ "$ref": "#/components/schemas/ManagedIdentifierKidOpts"
788
+ },
789
+ "returnType": {
790
+ "$ref": "#/components/schemas/ManagedIdentifierKidResult"
791
+ }
792
+ },
793
+ "identifierManagedGetByX5c": {
794
+ "description": "",
795
+ "arguments": {
796
+ "$ref": "#/components/schemas/ManagedIdentifierX5cOpts"
797
+ },
798
+ "returnType": {
799
+ "$ref": "#/components/schemas/ManagedIdentifierX5cResult"
800
+ }
801
+ }
802
+ }
803
+ }
804
+ }
805
+ }