@twin.org/attestation-connector-open-attestation 0.0.1-next.8 → 0.0.1
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.
- package/dist/cjs/index.cjs +1 -3
- package/dist/esm/index.mjs +1 -3
- package/dist/types/index.d.ts +1 -0
- package/dist/types/models/IOpenAttestationConnectorConstructorOptions.d.ts +10 -0
- package/dist/types/openAttestationConnector.d.ts +3 -7
- package/docs/changelog.md +100 -1
- package/docs/reference/classes/OpenAttestationConnector.md +36 -22
- package/docs/reference/index.md +1 -0
- package/docs/reference/interfaces/IOpenAttestationConnectorConstructorOptions.md +11 -0
- package/package.json +11 -11
package/dist/cjs/index.cjs
CHANGED
|
@@ -17,19 +17,17 @@ class OpenAttestationConnector {
|
|
|
17
17
|
/**
|
|
18
18
|
* Create a new instance of OpenAttestationConnector.
|
|
19
19
|
* @param options The options for the attestation connector.
|
|
20
|
-
* @param options.config The configuration for the attestation connector.
|
|
21
20
|
*/
|
|
22
21
|
// eslint-disable-next-line @typescript-eslint/no-useless-constructor
|
|
23
22
|
constructor(options) { }
|
|
24
23
|
/**
|
|
25
24
|
* Attest the data and return the collated information.
|
|
26
25
|
* @param controller The controller identity of the user to access the vault keys.
|
|
27
|
-
* @param address The controller address for the attestation.
|
|
28
26
|
* @param verificationMethodId The identity verification method to use for attesting the data.
|
|
29
27
|
* @param attestationObject The data to attest.
|
|
30
28
|
* @returns The id.
|
|
31
29
|
*/
|
|
32
|
-
async create(controller,
|
|
30
|
+
async create(controller, verificationMethodId, attestationObject) {
|
|
33
31
|
throw new core.NotImplementedError(this.CLASS_NAME, "attest");
|
|
34
32
|
}
|
|
35
33
|
/**
|
package/dist/esm/index.mjs
CHANGED
|
@@ -15,19 +15,17 @@ class OpenAttestationConnector {
|
|
|
15
15
|
/**
|
|
16
16
|
* Create a new instance of OpenAttestationConnector.
|
|
17
17
|
* @param options The options for the attestation connector.
|
|
18
|
-
* @param options.config The configuration for the attestation connector.
|
|
19
18
|
*/
|
|
20
19
|
// eslint-disable-next-line @typescript-eslint/no-useless-constructor
|
|
21
20
|
constructor(options) { }
|
|
22
21
|
/**
|
|
23
22
|
* Attest the data and return the collated information.
|
|
24
23
|
* @param controller The controller identity of the user to access the vault keys.
|
|
25
|
-
* @param address The controller address for the attestation.
|
|
26
24
|
* @param verificationMethodId The identity verification method to use for attesting the data.
|
|
27
25
|
* @param attestationObject The data to attest.
|
|
28
26
|
* @returns The id.
|
|
29
27
|
*/
|
|
30
|
-
async create(controller,
|
|
28
|
+
async create(controller, verificationMethodId, attestationObject) {
|
|
31
29
|
throw new NotImplementedError(this.CLASS_NAME, "attest");
|
|
32
30
|
}
|
|
33
31
|
/**
|
package/dist/types/index.d.ts
CHANGED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { IOpenAttestationConnectorConfig } from "./IOpenAttestationConnectorConfig";
|
|
2
|
+
/**
|
|
3
|
+
* Options for the Open Attestation connector constructor.
|
|
4
|
+
*/
|
|
5
|
+
export interface IOpenAttestationConnectorConstructorOptions {
|
|
6
|
+
/**
|
|
7
|
+
* The configuration for the connector.
|
|
8
|
+
*/
|
|
9
|
+
config?: IOpenAttestationConnectorConfig;
|
|
10
|
+
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { IAttestationConnector, IAttestationInformation } from "@twin.org/attestation-models";
|
|
2
2
|
import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
|
|
3
|
-
import type {
|
|
3
|
+
import type { IOpenAttestationConnectorConstructorOptions } from "./models/IOpenAttestationConnectorConstructorOptions";
|
|
4
4
|
/**
|
|
5
5
|
* Class for performing attestation operations in entity storage.
|
|
6
6
|
*/
|
|
@@ -16,20 +16,16 @@ export declare class OpenAttestationConnector implements IAttestationConnector {
|
|
|
16
16
|
/**
|
|
17
17
|
* Create a new instance of OpenAttestationConnector.
|
|
18
18
|
* @param options The options for the attestation connector.
|
|
19
|
-
* @param options.config The configuration for the attestation connector.
|
|
20
19
|
*/
|
|
21
|
-
constructor(options:
|
|
22
|
-
config?: IOpenAttestationConnectorConfig;
|
|
23
|
-
});
|
|
20
|
+
constructor(options: IOpenAttestationConnectorConstructorOptions);
|
|
24
21
|
/**
|
|
25
22
|
* Attest the data and return the collated information.
|
|
26
23
|
* @param controller The controller identity of the user to access the vault keys.
|
|
27
|
-
* @param address The controller address for the attestation.
|
|
28
24
|
* @param verificationMethodId The identity verification method to use for attesting the data.
|
|
29
25
|
* @param attestationObject The data to attest.
|
|
30
26
|
* @returns The id.
|
|
31
27
|
*/
|
|
32
|
-
create(controller: string,
|
|
28
|
+
create(controller: string, verificationMethodId: string, attestationObject: IJsonLdNodeObject): Promise<string>;
|
|
33
29
|
/**
|
|
34
30
|
* Resolve and verify the attestation id.
|
|
35
31
|
* @param id The attestation id to verify.
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,104 @@
|
|
|
1
1
|
# @twin.org/attestation-connector-open-attestation - Changelog
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## 0.0.1 (2025-07-09)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* release to production ([aa69a08](https://github.com/twinfoundation/attestation/commit/aa69a08fbd3897c8d72b0d32ec730f104ad31b33))
|
|
9
|
+
* release to production ([89ca987](https://github.com/twinfoundation/attestation/commit/89ca987963d9090abcfc1b62bc997e2c521944ec))
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
### Dependencies
|
|
13
|
+
|
|
14
|
+
* The following workspace dependencies were updated
|
|
15
|
+
* dependencies
|
|
16
|
+
* @twin.org/attestation-models bumped from ^0.0.0 to ^0.0.1
|
|
17
|
+
|
|
18
|
+
## [0.0.1-next.30](https://github.com/twinfoundation/attestation/compare/attestation-connector-open-attestation-v0.0.1-next.29...attestation-connector-open-attestation-v0.0.1-next.30) (2025-06-12)
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
### Features
|
|
22
|
+
|
|
23
|
+
* update dependencies ([1d96d2e](https://github.com/twinfoundation/attestation/commit/1d96d2ee6e81a30396980f6f5e16e9658710d32d))
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
### Dependencies
|
|
27
|
+
|
|
28
|
+
* The following workspace dependencies were updated
|
|
29
|
+
* dependencies
|
|
30
|
+
* @twin.org/attestation-models bumped from 0.0.1-next.29 to 0.0.1-next.30
|
|
31
|
+
|
|
32
|
+
## [0.0.1-next.29](https://github.com/twinfoundation/attestation/compare/attestation-connector-open-attestation-v0.0.1-next.28...attestation-connector-open-attestation-v0.0.1-next.29) (2025-06-03)
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
### Miscellaneous Chores
|
|
36
|
+
|
|
37
|
+
* **attestation-connector-open-attestation:** Synchronize repo versions
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
### Dependencies
|
|
41
|
+
|
|
42
|
+
* The following workspace dependencies were updated
|
|
43
|
+
* dependencies
|
|
44
|
+
* @twin.org/attestation-models bumped from 0.0.1-next.28 to 0.0.1-next.29
|
|
45
|
+
|
|
46
|
+
## [0.0.1-next.28](https://github.com/twinfoundation/attestation/compare/attestation-connector-open-attestation-v0.0.1-next.27...attestation-connector-open-attestation-v0.0.1-next.28) (2025-05-28)
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
### Miscellaneous Chores
|
|
50
|
+
|
|
51
|
+
* **attestation-connector-open-attestation:** Synchronize repo versions
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
### Dependencies
|
|
55
|
+
|
|
56
|
+
* The following workspace dependencies were updated
|
|
57
|
+
* dependencies
|
|
58
|
+
* @twin.org/attestation-models bumped from 0.0.1-next.27 to 0.0.1-next.28
|
|
59
|
+
|
|
60
|
+
## [0.0.1-next.27](https://github.com/twinfoundation/attestation/compare/attestation-connector-open-attestation-v0.0.1-next.26...attestation-connector-open-attestation-v0.0.1-next.27) (2025-05-06)
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
### Miscellaneous Chores
|
|
64
|
+
|
|
65
|
+
* **attestation-connector-open-attestation:** Synchronize repo versions
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
### Dependencies
|
|
69
|
+
|
|
70
|
+
* The following workspace dependencies were updated
|
|
71
|
+
* dependencies
|
|
72
|
+
* @twin.org/attestation-models bumped from 0.0.1-next.26 to 0.0.1-next.27
|
|
73
|
+
|
|
74
|
+
## [0.0.1-next.26](https://github.com/twinfoundation/attestation/compare/attestation-connector-open-attestation-v0.0.1-next.25...attestation-connector-open-attestation-v0.0.1-next.26) (2025-04-17)
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
### Features
|
|
78
|
+
|
|
79
|
+
* use shared store mechanism ([#5](https://github.com/twinfoundation/attestation/issues/5)) ([3768cf7](https://github.com/twinfoundation/attestation/commit/3768cf7214d30a5429b7b08190539b517d7fafa0))
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
### Dependencies
|
|
83
|
+
|
|
84
|
+
* The following workspace dependencies were updated
|
|
85
|
+
* dependencies
|
|
86
|
+
* @twin.org/attestation-models bumped from 0.0.1-next.25 to 0.0.1-next.26
|
|
87
|
+
|
|
88
|
+
## [0.0.1-next.25](https://github.com/twinfoundation/attestation/compare/attestation-connector-open-attestation-v0.0.1-next.24...attestation-connector-open-attestation-v0.0.1-next.25) (2025-03-28)
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
### Miscellaneous Chores
|
|
92
|
+
|
|
93
|
+
* **attestation-connector-open-attestation:** Synchronize repo versions
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
### Dependencies
|
|
97
|
+
|
|
98
|
+
* The following workspace dependencies were updated
|
|
99
|
+
* dependencies
|
|
100
|
+
* @twin.org/attestation-models bumped from 0.0.1-next.24 to 0.0.1-next.25
|
|
101
|
+
|
|
102
|
+
## v0.0.1-next.24
|
|
4
103
|
|
|
5
104
|
- Initial Release
|
|
@@ -8,25 +8,23 @@ Class for performing attestation operations in entity storage.
|
|
|
8
8
|
|
|
9
9
|
## Constructors
|
|
10
10
|
|
|
11
|
-
###
|
|
11
|
+
### Constructor
|
|
12
12
|
|
|
13
|
-
> **new OpenAttestationConnector**(`options`):
|
|
13
|
+
> **new OpenAttestationConnector**(`options`): `OpenAttestationConnector`
|
|
14
14
|
|
|
15
15
|
Create a new instance of OpenAttestationConnector.
|
|
16
16
|
|
|
17
17
|
#### Parameters
|
|
18
18
|
|
|
19
|
-
|
|
19
|
+
##### options
|
|
20
20
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
• **options.config?**: [`IOpenAttestationConnectorConfig`](../interfaces/IOpenAttestationConnectorConfig.md)
|
|
21
|
+
[`IOpenAttestationConnectorConstructorOptions`](../interfaces/IOpenAttestationConnectorConstructorOptions.md)
|
|
24
22
|
|
|
25
|
-
The
|
|
23
|
+
The options for the attestation connector.
|
|
26
24
|
|
|
27
25
|
#### Returns
|
|
28
26
|
|
|
29
|
-
|
|
27
|
+
`OpenAttestationConnector`
|
|
30
28
|
|
|
31
29
|
## Properties
|
|
32
30
|
|
|
@@ -52,25 +50,27 @@ Runtime name for the class.
|
|
|
52
50
|
|
|
53
51
|
### create()
|
|
54
52
|
|
|
55
|
-
> **create**(`controller`, `
|
|
53
|
+
> **create**(`controller`, `verificationMethodId`, `attestationObject`): `Promise`\<`string`\>
|
|
56
54
|
|
|
57
55
|
Attest the data and return the collated information.
|
|
58
56
|
|
|
59
57
|
#### Parameters
|
|
60
58
|
|
|
61
|
-
|
|
59
|
+
##### controller
|
|
62
60
|
|
|
63
|
-
|
|
61
|
+
`string`
|
|
64
62
|
|
|
65
|
-
|
|
63
|
+
The controller identity of the user to access the vault keys.
|
|
66
64
|
|
|
67
|
-
|
|
65
|
+
##### verificationMethodId
|
|
68
66
|
|
|
69
|
-
|
|
67
|
+
`string`
|
|
70
68
|
|
|
71
69
|
The identity verification method to use for attesting the data.
|
|
72
70
|
|
|
73
|
-
|
|
71
|
+
##### attestationObject
|
|
72
|
+
|
|
73
|
+
`IJsonLdNodeObject`
|
|
74
74
|
|
|
75
75
|
The data to attest.
|
|
76
76
|
|
|
@@ -94,7 +94,9 @@ Resolve and verify the attestation id.
|
|
|
94
94
|
|
|
95
95
|
#### Parameters
|
|
96
96
|
|
|
97
|
-
|
|
97
|
+
##### id
|
|
98
|
+
|
|
99
|
+
`string`
|
|
98
100
|
|
|
99
101
|
The attestation id to verify.
|
|
100
102
|
|
|
@@ -118,19 +120,27 @@ Transfer the attestation to a new holder.
|
|
|
118
120
|
|
|
119
121
|
#### Parameters
|
|
120
122
|
|
|
121
|
-
|
|
123
|
+
##### controller
|
|
124
|
+
|
|
125
|
+
`string`
|
|
122
126
|
|
|
123
127
|
The controller identity of the user to access the vault keys.
|
|
124
128
|
|
|
125
|
-
|
|
129
|
+
##### attestationId
|
|
130
|
+
|
|
131
|
+
`string`
|
|
126
132
|
|
|
127
133
|
The attestation to transfer.
|
|
128
134
|
|
|
129
|
-
|
|
135
|
+
##### holderIdentity
|
|
136
|
+
|
|
137
|
+
`string`
|
|
130
138
|
|
|
131
139
|
The holder identity of the attestation.
|
|
132
140
|
|
|
133
|
-
|
|
141
|
+
##### holderAddress
|
|
142
|
+
|
|
143
|
+
`string`
|
|
134
144
|
|
|
135
145
|
The new controller address of the attestation belonging to the holder.
|
|
136
146
|
|
|
@@ -154,11 +164,15 @@ Destroy the attestation.
|
|
|
154
164
|
|
|
155
165
|
#### Parameters
|
|
156
166
|
|
|
157
|
-
|
|
167
|
+
##### controller
|
|
168
|
+
|
|
169
|
+
`string`
|
|
158
170
|
|
|
159
171
|
The controller identity of the user to access the vault keys.
|
|
160
172
|
|
|
161
|
-
|
|
173
|
+
##### attestationId
|
|
174
|
+
|
|
175
|
+
`string`
|
|
162
176
|
|
|
163
177
|
The attestation to destroy.
|
|
164
178
|
|
package/docs/reference/index.md
CHANGED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Interface: IOpenAttestationConnectorConstructorOptions
|
|
2
|
+
|
|
3
|
+
Options for the Open Attestation connector constructor.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
### config?
|
|
8
|
+
|
|
9
|
+
> `optional` **config**: [`IOpenAttestationConnectorConfig`](IOpenAttestationConnectorConfig.md)
|
|
10
|
+
|
|
11
|
+
The configuration for the connector.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/attestation-connector-open-attestation",
|
|
3
|
-
"version": "0.0.1
|
|
3
|
+
"version": "0.0.1",
|
|
4
4
|
"description": "Attestation connector implementation using OpenAttestation",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -14,24 +14,24 @@
|
|
|
14
14
|
"node": ">=20.0.0"
|
|
15
15
|
},
|
|
16
16
|
"dependencies": {
|
|
17
|
-
"@govtechsg/open-attestation": "6.9.
|
|
18
|
-
"@twin.org/attestation-models": "0.0.1
|
|
19
|
-
"@twin.org/core": "
|
|
20
|
-
"@twin.org/data-json-ld": "
|
|
21
|
-
"@twin.org/entity": "
|
|
22
|
-
"@twin.org/nameof": "
|
|
23
|
-
"@twin.org/standards-w3c-did": "
|
|
17
|
+
"@govtechsg/open-attestation": "6.9.7",
|
|
18
|
+
"@twin.org/attestation-models": "^0.0.1",
|
|
19
|
+
"@twin.org/core": "^0.0.1",
|
|
20
|
+
"@twin.org/data-json-ld": "^0.0.1",
|
|
21
|
+
"@twin.org/entity": "^0.0.1",
|
|
22
|
+
"@twin.org/nameof": "^0.0.1",
|
|
23
|
+
"@twin.org/standards-w3c-did": "^0.0.1"
|
|
24
24
|
},
|
|
25
25
|
"main": "./dist/cjs/index.cjs",
|
|
26
26
|
"module": "./dist/esm/index.mjs",
|
|
27
27
|
"types": "./dist/types/index.d.ts",
|
|
28
28
|
"exports": {
|
|
29
29
|
".": {
|
|
30
|
+
"types": "./dist/types/index.d.ts",
|
|
30
31
|
"require": "./dist/cjs/index.cjs",
|
|
31
|
-
"import": "./dist/esm/index.mjs"
|
|
32
|
-
"types": "./dist/types/index.d.ts"
|
|
32
|
+
"import": "./dist/esm/index.mjs"
|
|
33
33
|
},
|
|
34
|
-
"./locales": "./locales"
|
|
34
|
+
"./locales/*.json": "./locales/*.json"
|
|
35
35
|
},
|
|
36
36
|
"files": [
|
|
37
37
|
"dist/cjs",
|