@sphereon/ssi-sdk.data-store 0.19.0 → 0.19.1-next.100

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 (110) hide show
  1. package/dist/digitalCredential/AbstractDigitalCredentialStore.d.ts +10 -0
  2. package/dist/digitalCredential/AbstractDigitalCredentialStore.d.ts.map +1 -0
  3. package/dist/digitalCredential/AbstractDigitalCredentialStore.js +7 -0
  4. package/dist/digitalCredential/AbstractDigitalCredentialStore.js.map +1 -0
  5. package/dist/digitalCredential/DigitalCredentialStore.d.ts +15 -0
  6. package/dist/digitalCredential/DigitalCredentialStore.d.ts.map +1 -0
  7. package/dist/digitalCredential/DigitalCredentialStore.js +118 -0
  8. package/dist/digitalCredential/DigitalCredentialStore.js.map +1 -0
  9. package/dist/entities/digitalCredential/DigitalCredentialEntity.d.ts +23 -0
  10. package/dist/entities/digitalCredential/DigitalCredentialEntity.d.ts.map +1 -0
  11. package/dist/entities/digitalCredential/DigitalCredentialEntity.js +93 -0
  12. package/dist/entities/digitalCredential/DigitalCredentialEntity.js.map +1 -0
  13. package/dist/entities/machineState/MachineStateInfoEntity.d.ts +33 -0
  14. package/dist/entities/machineState/MachineStateInfoEntity.d.ts.map +1 -0
  15. package/dist/entities/machineState/MachineStateInfoEntity.js +85 -0
  16. package/dist/entities/machineState/MachineStateInfoEntity.js.map +1 -0
  17. package/dist/index.d.ts +10 -3
  18. package/dist/index.d.ts.map +1 -1
  19. package/dist/index.js +19 -1
  20. package/dist/index.js.map +1 -1
  21. package/dist/machineState/IAbstractMachineStateStore.d.ts +52 -0
  22. package/dist/machineState/IAbstractMachineStateStore.d.ts.map +1 -0
  23. package/dist/machineState/IAbstractMachineStateStore.js +13 -0
  24. package/dist/machineState/IAbstractMachineStateStore.js.map +1 -0
  25. package/dist/machineState/MachineStateStore.d.ts +21 -0
  26. package/dist/machineState/MachineStateStore.d.ts.map +1 -0
  27. package/dist/machineState/MachineStateStore.js +139 -0
  28. package/dist/machineState/MachineStateStore.js.map +1 -0
  29. package/dist/migrations/generic/6-CreateDigitalCredential.d.ts +7 -0
  30. package/dist/migrations/generic/6-CreateDigitalCredential.d.ts.map +1 -0
  31. package/dist/migrations/generic/6-CreateDigitalCredential.js +78 -0
  32. package/dist/migrations/generic/6-CreateDigitalCredential.js.map +1 -0
  33. package/dist/migrations/generic/7-CreateMachineStateStore.d.ts +7 -0
  34. package/dist/migrations/generic/7-CreateMachineStateStore.d.ts.map +1 -0
  35. package/dist/migrations/generic/7-CreateMachineStateStore.js +78 -0
  36. package/dist/migrations/generic/7-CreateMachineStateStore.js.map +1 -0
  37. package/dist/migrations/generic/index.d.ts +4 -0
  38. package/dist/migrations/generic/index.d.ts.map +1 -1
  39. package/dist/migrations/generic/index.js +7 -1
  40. package/dist/migrations/generic/index.js.map +1 -1
  41. package/dist/migrations/index.d.ts +1 -1
  42. package/dist/migrations/index.d.ts.map +1 -1
  43. package/dist/migrations/index.js +3 -1
  44. package/dist/migrations/index.js.map +1 -1
  45. package/dist/migrations/postgres/1708525189001-CreateDigitalCredential.d.ts +7 -0
  46. package/dist/migrations/postgres/1708525189001-CreateDigitalCredential.d.ts.map +1 -0
  47. package/dist/migrations/postgres/1708525189001-CreateDigitalCredential.js +59 -0
  48. package/dist/migrations/postgres/1708525189001-CreateDigitalCredential.js.map +1 -0
  49. package/dist/migrations/postgres/1708797018115-CreateMachineStateStore.d.ts +7 -0
  50. package/dist/migrations/postgres/1708797018115-CreateMachineStateStore.d.ts.map +1 -0
  51. package/dist/migrations/postgres/1708797018115-CreateMachineStateStore.js +45 -0
  52. package/dist/migrations/postgres/1708797018115-CreateMachineStateStore.js.map +1 -0
  53. package/dist/migrations/sqlite/1708525189002-CreateDigitalCredential.d.ts +7 -0
  54. package/dist/migrations/sqlite/1708525189002-CreateDigitalCredential.d.ts.map +1 -0
  55. package/dist/migrations/sqlite/1708525189002-CreateDigitalCredential.js +50 -0
  56. package/dist/migrations/sqlite/1708525189002-CreateDigitalCredential.js.map +1 -0
  57. package/dist/migrations/sqlite/1708796002272-CreateMachineStateStore.d.ts +7 -0
  58. package/dist/migrations/sqlite/1708796002272-CreateMachineStateStore.d.ts.map +1 -0
  59. package/dist/migrations/sqlite/1708796002272-CreateMachineStateStore.js +44 -0
  60. package/dist/migrations/sqlite/1708796002272-CreateMachineStateStore.js.map +1 -0
  61. package/dist/types/digitalCredential/IAbstractDigitalCredentialStore.d.ts +42 -0
  62. package/dist/types/digitalCredential/IAbstractDigitalCredentialStore.d.ts.map +1 -0
  63. package/dist/types/digitalCredential/IAbstractDigitalCredentialStore.js +3 -0
  64. package/dist/types/digitalCredential/IAbstractDigitalCredentialStore.js.map +1 -0
  65. package/dist/types/digitalCredential/digitalCredential.d.ts +42 -0
  66. package/dist/types/digitalCredential/digitalCredential.d.ts.map +1 -0
  67. package/dist/types/digitalCredential/digitalCredential.js +28 -0
  68. package/dist/types/digitalCredential/digitalCredential.js.map +1 -0
  69. package/dist/types/index.d.ts +1 -0
  70. package/dist/types/index.d.ts.map +1 -1
  71. package/dist/types/index.js +1 -0
  72. package/dist/types/index.js.map +1 -1
  73. package/dist/types/machineState/IAbstractMachineStateStore.d.ts +58 -0
  74. package/dist/types/machineState/IAbstractMachineStateStore.d.ts.map +1 -0
  75. package/dist/types/machineState/IAbstractMachineStateStore.js +3 -0
  76. package/dist/types/machineState/IAbstractMachineStateStore.js.map +1 -0
  77. package/dist/utils/SortingUtils.d.ts +3 -0
  78. package/dist/utils/SortingUtils.d.ts.map +1 -0
  79. package/dist/utils/SortingUtils.js +18 -0
  80. package/dist/utils/SortingUtils.js.map +1 -0
  81. package/dist/utils/digitalCredential/MappingUtils.d.ts +7 -0
  82. package/dist/utils/digitalCredential/MappingUtils.d.ts.map +1 -0
  83. package/dist/utils/digitalCredential/MappingUtils.js +99 -0
  84. package/dist/utils/digitalCredential/MappingUtils.js.map +1 -0
  85. package/package.json +5 -4
  86. package/src/__tests__/digitalCredential.entities.test.ts +254 -0
  87. package/src/__tests__/digitalCredential.store.test.ts +294 -0
  88. package/src/__tests__/machineState.entities.test.ts +51 -0
  89. package/src/__tests__/machineState.store.test.ts +174 -0
  90. package/src/digitalCredential/AbstractDigitalCredentialStore.ts +17 -0
  91. package/src/digitalCredential/DigitalCredentialStore.ts +127 -0
  92. package/src/entities/digitalCredential/DigitalCredentialEntity.ts +64 -0
  93. package/src/entities/machineState/MachineStateInfoEntity.ts +58 -0
  94. package/src/index.ts +18 -0
  95. package/src/machineState/IAbstractMachineStateStore.ts +65 -0
  96. package/src/machineState/MachineStateStore.ts +149 -0
  97. package/src/migrations/generic/6-CreateDigitalCredential.ts +66 -0
  98. package/src/migrations/generic/7-CreateMachineStateStore.ts +66 -0
  99. package/src/migrations/generic/index.ts +6 -0
  100. package/src/migrations/index.ts +2 -0
  101. package/src/migrations/postgres/1708525189001-CreateDigitalCredential.ts +44 -0
  102. package/src/migrations/postgres/1708797018115-CreateMachineStateStore.ts +29 -0
  103. package/src/migrations/sqlite/1708525189002-CreateDigitalCredential.ts +34 -0
  104. package/src/migrations/sqlite/1708796002272-CreateMachineStateStore.ts +28 -0
  105. package/src/types/digitalCredential/IAbstractDigitalCredentialStore.ts +37 -0
  106. package/src/types/digitalCredential/digitalCredential.ts +46 -0
  107. package/src/types/index.ts +1 -0
  108. package/src/types/machineState/IAbstractMachineStateStore.ts +68 -0
  109. package/src/utils/SortingUtils.ts +16 -0
  110. package/src/utils/digitalCredential/MappingUtils.ts +122 -0
@@ -0,0 +1,122 @@
1
+ import { AddCredentialArgs } from '../../types/digitalCredential/IAbstractDigitalCredentialStore'
2
+ import { DigitalCredentialEntity } from '../../entities/digitalCredential/DigitalCredentialEntity'
3
+ import {
4
+ CredentialMapper,
5
+ decodeSdJwtVc,
6
+ DocumentFormat,
7
+ IVerifiableCredential,
8
+ IVerifiablePresentation,
9
+ OriginalVerifiableCredential,
10
+ OriginalVerifiablePresentation,
11
+ SdJwtDecodedVerifiableCredentialPayload,
12
+ } from '@sphereon/ssi-types'
13
+ import {
14
+ CredentialDocumentFormat,
15
+ DocumentType,
16
+ DigitalCredential,
17
+ NonPersistedDigitalCredential,
18
+ } from '../../types/digitalCredential/digitalCredential'
19
+ import { computeEntryHash } from '@veramo/utils'
20
+
21
+ function determineDocumentType(raw: string): DocumentType {
22
+ const rawDocument = parseRawDocument(raw)
23
+ if (!rawDocument) {
24
+ throw new Error(`Couldn't parse the credential: ${raw}`)
25
+ }
26
+
27
+ const hasProof = CredentialMapper.hasProof(rawDocument)
28
+ const isCredential = CredentialMapper.isCredential(rawDocument)
29
+ const isPresentation = CredentialMapper.isPresentation(rawDocument)
30
+
31
+ if (isCredential) {
32
+ return hasProof ? DocumentType.VC : DocumentType.C
33
+ } else if (isPresentation) {
34
+ return hasProof ? DocumentType.VP : DocumentType.P
35
+ }
36
+ throw new Error(`Couldn't determine the type of the credential: ${raw}`)
37
+ }
38
+
39
+ function parseRawDocument(raw: string): OriginalVerifiableCredential | OriginalVerifiablePresentation {
40
+ if (CredentialMapper.isJwtEncoded(raw) || CredentialMapper.isSdJwtEncoded(raw)) {
41
+ return raw
42
+ }
43
+ try {
44
+ return JSON.parse(raw)
45
+ } catch (e) {
46
+ throw new Error(`Can't parse the raw credential: ${raw}`)
47
+ }
48
+ }
49
+
50
+ function determineCredentialDocumentFormat(documentFormat: DocumentFormat): CredentialDocumentFormat {
51
+ switch (documentFormat) {
52
+ case DocumentFormat.JSONLD:
53
+ return CredentialDocumentFormat.JSON_LD
54
+ case DocumentFormat.JWT:
55
+ return CredentialDocumentFormat.JWT
56
+ case DocumentFormat.SD_JWT_VC:
57
+ return CredentialDocumentFormat.SD_JWT
58
+ default:
59
+ throw new Error(`Not supported document format: ${documentFormat}`)
60
+ }
61
+ }
62
+
63
+ function getValidUntil(uniformDocument: IVerifiableCredential | IVerifiablePresentation | SdJwtDecodedVerifiableCredentialPayload): Date | undefined {
64
+ if ('expirationDate' in uniformDocument) {
65
+ return new Date(uniformDocument.expirationDate)
66
+ } else if ('validUntil' in uniformDocument) {
67
+ return new Date(uniformDocument.validUntil)
68
+ } else if ('exp' in uniformDocument) {
69
+ return new Date(uniformDocument.exp)
70
+ }
71
+ return undefined
72
+ }
73
+
74
+ function getValidFrom(uniformDocument: IVerifiableCredential | IVerifiablePresentation | SdJwtDecodedVerifiableCredentialPayload): Date | undefined {
75
+ if ('issuanceDate' in uniformDocument) {
76
+ return new Date(uniformDocument.issuanceDate)
77
+ } else if ('validFrom' in uniformDocument) {
78
+ return new Date(uniformDocument['validFrom'])
79
+ } else if ('nbf' in uniformDocument) {
80
+ return new Date(uniformDocument['nbf'] * 1000)
81
+ } else if ('iat' in uniformDocument) {
82
+ return new Date(uniformDocument['iat'] * 1000)
83
+ }
84
+ return undefined
85
+ }
86
+
87
+ export const nonPersistedDigitalCredentialEntityFromAddArgs = (addCredentialArgs: AddCredentialArgs): NonPersistedDigitalCredential => {
88
+ const documentType: DocumentType = determineDocumentType(addCredentialArgs.rawDocument)
89
+ const documentFormat: DocumentFormat = CredentialMapper.detectDocumentType(addCredentialArgs.rawDocument)
90
+ if (documentFormat === DocumentFormat.SD_JWT_VC && !addCredentialArgs.opts?.hasher) {
91
+ throw new Error('No hasher function is provided for SD_JWT credential.')
92
+ }
93
+ const uniformDocument =
94
+ documentFormat === DocumentFormat.SD_JWT_VC
95
+ ? decodeSdJwtVc(addCredentialArgs.rawDocument, addCredentialArgs.opts!.hasher!).decodedPayload
96
+ : documentType === DocumentType.VC || documentType === DocumentType.C
97
+ ? CredentialMapper.toUniformCredential(addCredentialArgs.rawDocument)
98
+ : CredentialMapper.toUniformPresentation(addCredentialArgs.rawDocument)
99
+ const validFrom: Date | undefined = getValidFrom(uniformDocument)
100
+ const validUntil: Date | undefined = getValidUntil(uniformDocument)
101
+ return {
102
+ ...addCredentialArgs,
103
+ documentType,
104
+ documentFormat: determineCredentialDocumentFormat(documentFormat),
105
+ createdAt: new Date(),
106
+ hash: computeEntryHash(addCredentialArgs.rawDocument),
107
+ uniformDocument: JSON.stringify(uniformDocument),
108
+ validFrom,
109
+ validUntil,
110
+ lastUpdatedAt: new Date(),
111
+ }
112
+ }
113
+
114
+ export const digitalCredentialFrom = (credentialEntity: DigitalCredentialEntity): DigitalCredential => {
115
+ return {
116
+ ...credentialEntity,
117
+ }
118
+ }
119
+
120
+ export const digitalCredentialsFrom = (credentialEntities: Array<DigitalCredentialEntity>): DigitalCredential[] => {
121
+ return credentialEntities.map((credentialEntity) => digitalCredentialFrom(credentialEntity))
122
+ }