@twin.org/immutable-proof-service 0.0.3-next.10 → 0.0.3-next.12

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 (9) hide show
  1. package/README.md +1 -1
  2. package/docs/changelog.md +79 -49
  3. package/docs/examples.md +127 -1
  4. package/docs/open-api/spec.json +8 -693
  5. package/docs/reference/classes/ImmutableProof.md +10 -10
  6. package/docs/reference/classes/ImmutableProofService.md +7 -7
  7. package/docs/reference/interfaces/IImmutableProofServiceConfig.md +2 -2
  8. package/docs/reference/interfaces/IImmutableProofServiceConstructorOptions.md +14 -14
  9. package/package.json +6 -6
package/docs/reference/classes/ImmutableProof.md CHANGED
@@ -14,7 +14,7 @@ Class describing the immutable proof.
14
14
 
15
15
  ## Properties
16
16
 
17
- ### id
17
+ ### id {#id}
18
18
 
19
19
  > **id**: `string`
20
20
 
@@ -22,7 +22,7 @@ The id of the proof.
22
22
 
23
23
  ***
24
24
 
25
- ### organizationId
25
+ ### organizationId {#organizationid}
26
26
 
27
27
  > **organizationId**: `string`
28
28
 
@@ -30,7 +30,7 @@ The organization id.
30
30
 
31
31
  ***
32
32
 
33
- ### dateCreated
33
+ ### dateCreated {#datecreated}
34
34
 
35
35
  > **dateCreated**: `string`
36
36
 
@@ -38,15 +38,15 @@ The date/time of when the proof was created.
38
38
 
39
39
  ***
40
40
 
41
- ### proofObjectId?
41
+ ### proofObjectId? {#proofobjectid}
42
42
 
43
- > `optional` **proofObjectId**: `string`
43
+ > `optional` **proofObjectId?**: `string`
44
44
 
45
45
  The associated id for the item.
46
46
 
47
47
  ***
48
48
 
49
- ### proofObjectIntegrity
49
+ ### proofObjectIntegrity {#proofobjectintegrity}
50
50
 
51
51
  > **proofObjectIntegrity**: `string`
52
52
 
@@ -54,16 +54,16 @@ The associated integrity for the item.
54
54
 
55
55
  ***
56
56
 
57
- ### verifiableStorageId?
57
+ ### verifiableStorageId? {#verifiablestorageid}
58
58
 
59
- > `optional` **verifiableStorageId**: `string`
59
+ > `optional` **verifiableStorageId?**: `string`
60
60
 
61
61
  The verifiable storage id.
62
62
 
63
63
  ***
64
64
 
65
- ### vcContext?
65
+ ### vcContext? {#vccontext}
66
66
 
67
- > `optional` **vcContext**: `"https://www.w3.org/2018/credentials/v1"` \| `"https://www.w3.org/ns/credentials/v2"`
67
+ > `optional` **vcContext?**: `"https://www.w3.org/2018/credentials/v1"` \| `"https://www.w3.org/ns/credentials/v2"`
68
68
 
69
69
  The verifiable credential context.
package/docs/reference/classes/ImmutableProofService.md CHANGED
@@ -28,7 +28,7 @@ The dependencies for the immutable proof connector.
28
28
 
29
29
  ## Properties
30
30
 
31
- ### CLASS\_NAME
31
+ ### CLASS\_NAME {#class_name}
32
32
 
33
33
  > `readonly` `static` **CLASS\_NAME**: `string`
34
34
 
@@ -36,7 +36,7 @@ Runtime name for the class.
36
36
 
37
37
  ## Methods
38
38
 
39
- ### className()
39
+ ### className() {#classname}
40
40
 
41
41
  > **className**(): `string`
42
42
 
@@ -54,7 +54,7 @@ The class name of the component.
54
54
 
55
55
  ***
56
56
 
57
- ### start()
57
+ ### start() {#start}
58
58
 
59
59
  > **start**(`nodeLoggingComponentType?`): `Promise`\<`void`\>
60
60
 
@@ -80,7 +80,7 @@ Nothing.
80
80
 
81
81
  ***
82
82
 
83
- ### create()
83
+ ### create() {#create}
84
84
 
85
85
  > **create**(`document`): `Promise`\<`string`\>
86
86
 
@@ -106,7 +106,7 @@ The id of the new proof.
106
106
 
107
107
  ***
108
108
 
109
- ### get()
109
+ ### get() {#get}
110
110
 
111
111
  > **get**(`id`): `Promise`\<`IDidVerifiableCredential`\>
112
112
 
@@ -136,7 +136,7 @@ NotFoundError if the proof is not found.
136
136
 
137
137
  ***
138
138
 
139
- ### verify()
139
+ ### verify() {#verify}
140
140
 
141
141
  > **verify**(`id`): `Promise`\<`IImmutableProofVerification`\>
142
142
 
@@ -166,7 +166,7 @@ NotFoundError if the proof is not found.
166
166
 
167
167
  ***
168
168
 
169
- ### removeVerifiable()
169
+ ### removeVerifiable() {#removeverifiable}
170
170
 
171
171
  > **removeVerifiable**(`id`): `Promise`\<`void`\>
172
172
 
package/docs/reference/interfaces/IImmutableProofServiceConfig.md CHANGED
@@ -4,9 +4,9 @@ Configuration for the immutable proof service.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### verificationMethodId?
7
+ ### verificationMethodId? {#verificationmethodid}
8
8
 
9
- > `optional` **verificationMethodId**: `string`
9
+ > `optional` **verificationMethodId?**: `string`
10
10
 
11
11
  The verification method id to use for the proof.
12
12
 
package/docs/reference/interfaces/IImmutableProofServiceConstructorOptions.md CHANGED
@@ -4,9 +4,9 @@ Options for the immutable proof service constructor.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### immutableProofEntityStorageType?
7
+ ### immutableProofEntityStorageType? {#immutableproofentitystoragetype}
8
8
 
9
- > `optional` **immutableProofEntityStorageType**: `string`
9
+ > `optional` **immutableProofEntityStorageType?**: `string`
10
10
 
11
11
  The entity storage for proofs.
12
12
 
@@ -18,9 +18,9 @@ immutable-proof
18
18
 
19
19
  ***
20
20
 
21
- ### verifiableStorageType?
21
+ ### verifiableStorageType? {#verifiablestoragetype}
22
22
 
23
- > `optional` **verifiableStorageType**: `string`
23
+ > `optional` **verifiableStorageType?**: `string`
24
24
 
25
25
  The verifiable storage.
26
26
 
@@ -32,9 +32,9 @@ verifiable-storage
32
32
 
33
33
  ***
34
34
 
35
- ### loggingComponentType?
35
+ ### loggingComponentType? {#loggingcomponenttype}
36
36
 
37
- > `optional` **loggingComponentType**: `string`
37
+ > `optional` **loggingComponentType?**: `string`
38
38
 
39
39
  The logging component type.
40
40
 
@@ -46,9 +46,9 @@ logging
46
46
 
47
47
  ***
48
48
 
49
- ### identityConnectorType?
49
+ ### identityConnectorType? {#identityconnectortype}
50
50
 
51
- > `optional` **identityConnectorType**: `string`
51
+ > `optional` **identityConnectorType?**: `string`
52
52
 
53
53
  The identity connector type.
54
54
 
@@ -60,9 +60,9 @@ identity
60
60
 
61
61
  ***
62
62
 
63
- ### backgroundTaskComponentType?
63
+ ### backgroundTaskComponentType? {#backgroundtaskcomponenttype}
64
64
 
65
- > `optional` **backgroundTaskComponentType**: `string`
65
+ > `optional` **backgroundTaskComponentType?**: `string`
66
66
 
67
67
  The background task component type.
68
68
 
@@ -74,16 +74,16 @@ background-task
74
74
 
75
75
  ***
76
76
 
77
- ### eventBusComponentType?
77
+ ### eventBusComponentType? {#eventbuscomponenttype}
78
78
 
79
- > `optional` **eventBusComponentType**: `string`
79
+ > `optional` **eventBusComponentType?**: `string`
80
80
 
81
81
  The event bus component type, defaults to no event bus.
82
82
 
83
83
  ***
84
84
 
85
- ### config?
85
+ ### config? {#config}
86
86
 
87
- > `optional` **config**: [`IImmutableProofServiceConfig`](IImmutableProofServiceConfig.md)
87
+ > `optional` **config?**: [`IImmutableProofServiceConfig`](IImmutableProofServiceConfig.md)
88
88
 
89
89
  The configuration for the connector.
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@twin.org/immutable-proof-service",
3
- "version": "0.0.3-next.10",
4
- "description": "Immutable proof contract implementation and REST endpoint definitions",
3
+ "version": "0.0.3-next.12",
4
+ "description": "Core proof lifecycle service with route helpers for create, get, and verify operations",
5
5
  "repository": {
6
6
  "type": "git",
7
- "url": "git+https://github.com/twinfoundation/immutable-proof.git",
7
+ "url": "git+https://github.com/iotaledger/immutable-proof.git",
8
8
  "directory": "packages/immutable-proof-service"
9
9
  },
10
10
  "author": "martyn.janes@iota.org",
@@ -24,8 +24,8 @@
24
24
  "@twin.org/entity-storage-models": "next",
25
25
  "@twin.org/event-bus-models": "next",
26
26
  "@twin.org/identity-models": "next",
27
- "@twin.org/immutable-proof-models": "0.0.3-next.10",
28
- "@twin.org/immutable-proof-task": "0.0.3-next.10",
27
+ "@twin.org/immutable-proof-models": "0.0.3-next.12",
28
+ "@twin.org/immutable-proof-task": "0.0.3-next.12",
29
29
  "@twin.org/logging-models": "next",
30
30
  "@twin.org/nameof": "next",
31
31
  "@twin.org/standards-w3c-did": "next",
@@ -61,7 +61,7 @@
61
61
  "business-logic"
62
62
  ],
63
63
  "bugs": {
64
- "url": "git+https://github.com/twinfoundation/immutable-proof/issues"
64
+ "url": "git+https://github.com/iotaledger/immutable-proof/issues"
65
65
  },
66
66
  "homepage": "https://twindev.org"
67
67
  }