@twin.org/auditable-item-graph-service 0.0.3-next.21 → 0.0.3-next.23
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/es/auditableItemGraphRoutes.js +53 -1
- package/dist/es/auditableItemGraphRoutes.js.map +1 -1
- package/dist/es/auditableItemGraphService.js +24 -20
- package/dist/es/auditableItemGraphService.js.map +1 -1
- package/dist/es/entities/auditableItemGraphVertex.js +1 -1
- package/dist/es/entities/auditableItemGraphVertex.js.map +1 -1
- package/dist/es/models/IAuditableItemGraphServiceContext.js +2 -0
- package/dist/es/models/IAuditableItemGraphServiceContext.js.map +1 -1
- package/dist/types/auditableItemGraphRoutes.d.ts +9 -1
- package/dist/types/auditableItemGraphService.d.ts +0 -14
- package/dist/types/entities/auditableItemGraphVertex.d.ts +1 -1
- package/dist/types/models/IAuditableItemGraphServiceContext.d.ts +6 -3
- package/docs/changelog.md +28 -0
- package/docs/open-api/spec.json +89 -0
- package/docs/reference/classes/AuditableItemGraphVertex.md +2 -2
- package/docs/reference/functions/auditableItemGraphRemoveProof.md +31 -0
- package/docs/reference/index.md +1 -0
- package/package.json +2 -2
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IAuditableItemGraphServiceContext.js","sourceRoot":"","sources":["../../../src/models/IAuditableItemGraphServiceContext.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\
|
|
1
|
+
{"version":3,"file":"IAuditableItemGraphServiceContext.js","sourceRoot":"","sources":["../../../src/models/IAuditableItemGraphServiceContext.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Context for the auditable item graph service.\n */\nexport interface IAuditableItemGraphServiceContext {\n\t/**\n\t * The current date/time.\n\t */\n\tnow: string;\n\n\t/**\n\t * The organization identity for the operation.\n\t */\n\torganizationIdentity: string;\n\n\t/**\n\t * The user identity for the operation.\n\t */\n\tuserIdentity?: string;\n}\n"]}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { type ICreatedResponse, type IHttpRequestContext, type INoContentResponse, type IRestRoute, type ITag } from "@twin.org/api-models";
|
|
2
|
-
import { type IAuditableItemGraphChangesetGetRequest, type IAuditableItemGraphChangesetGetResponse, type IAuditableItemGraphChangesetListRequest, type IAuditableItemGraphChangesetListResponse, type IAuditableItemGraphCreateRequest, type IAuditableItemGraphGetRequest, type IAuditableItemGraphGetResponse, type IAuditableItemGraphListRequest, type IAuditableItemGraphListResponse, type IAuditableItemGraphUpdateRequest, type IAuditableItemGraphUpdatePartialRequest, type IAuditableItemGraphVersionGetRequest, type IAuditableItemGraphVersionGetResponse, type IAuditableItemGraphVersionListRequest, type IAuditableItemGraphVersionListResponse } from "@twin.org/auditable-item-graph-models";
|
|
2
|
+
import { type IAuditableItemGraphChangesetGetRequest, type IAuditableItemGraphChangesetGetResponse, type IAuditableItemGraphChangesetListRequest, type IAuditableItemGraphChangesetListResponse, type IAuditableItemGraphCreateRequest, type IAuditableItemGraphGetRequest, type IAuditableItemGraphGetResponse, type IAuditableItemGraphListRequest, type IAuditableItemGraphListResponse, type IAuditableItemGraphRemoveProofRequest, type IAuditableItemGraphUpdateRequest, type IAuditableItemGraphUpdatePartialRequest, type IAuditableItemGraphVersionGetRequest, type IAuditableItemGraphVersionGetResponse, type IAuditableItemGraphVersionListRequest, type IAuditableItemGraphVersionListResponse } from "@twin.org/auditable-item-graph-models";
|
|
3
3
|
/**
|
|
4
4
|
* The tag to associate with the routes.
|
|
5
5
|
*/
|
|
@@ -75,6 +75,14 @@ export declare function auditableItemGraphList(httpRequestContext: IHttpRequestC
|
|
|
75
75
|
* @returns The response object with additional http response properties.
|
|
76
76
|
*/
|
|
77
77
|
export declare function auditableItemGraphVersionGet(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditableItemGraphVersionGetRequest): Promise<IAuditableItemGraphVersionGetResponse>;
|
|
78
|
+
/**
|
|
79
|
+
* Remove the notarization proof from all changesets of a graph vertex.
|
|
80
|
+
* @param httpRequestContext The request context for the API.
|
|
81
|
+
* @param componentName The name of the component to use in the routes.
|
|
82
|
+
* @param request The request.
|
|
83
|
+
* @returns The response object with additional http response properties.
|
|
84
|
+
*/
|
|
85
|
+
export declare function auditableItemGraphRemoveProof(httpRequestContext: IHttpRequestContext, componentName: string, request: IAuditableItemGraphRemoveProofRequest): Promise<INoContentResponse>;
|
|
78
86
|
/**
|
|
79
87
|
* Get all versions of a graph vertex.
|
|
80
88
|
* @param httpRequestContext The request context for the API.
|
|
@@ -147,18 +147,4 @@ export declare class AuditableItemGraphService implements IAuditableItemGraphCom
|
|
|
147
147
|
entries: IAuditableItemGraphVertexList;
|
|
148
148
|
cursor?: string;
|
|
149
149
|
}>;
|
|
150
|
-
/**
|
|
151
|
-
* Verify the signature of a changeset and add the verification result to the changeset JSON-LD.
|
|
152
|
-
* @param storedChangeset The changeset to verify.
|
|
153
|
-
* @returns Whether the changeset is verified.
|
|
154
|
-
*/
|
|
155
|
-
private verifyChangesetSignature;
|
|
156
|
-
/**
|
|
157
|
-
* Get the resource id from a resource object.
|
|
158
|
-
* @param resource The resource.
|
|
159
|
-
* @param resource.id The id of the resource.
|
|
160
|
-
* @param resource.resourceObject The resource object.
|
|
161
|
-
* @returns The resource id if it can find one.
|
|
162
|
-
*/
|
|
163
|
-
private getResourceId;
|
|
164
150
|
}
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import type { IContextIds } from "@twin.org/context";
|
|
2
1
|
/**
|
|
3
2
|
* Context for the auditable item graph service.
|
|
4
3
|
*/
|
|
@@ -8,7 +7,11 @@ export interface IAuditableItemGraphServiceContext {
|
|
|
8
7
|
*/
|
|
9
8
|
now: string;
|
|
10
9
|
/**
|
|
11
|
-
* The
|
|
10
|
+
* The organization identity for the operation.
|
|
12
11
|
*/
|
|
13
|
-
|
|
12
|
+
organizationIdentity: string;
|
|
13
|
+
/**
|
|
14
|
+
* The user identity for the operation.
|
|
15
|
+
*/
|
|
16
|
+
userIdentity?: string;
|
|
14
17
|
}
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,33 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.0.3-next.23](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-service-v0.0.3-next.22...auditable-item-graph-service-v0.0.3-next.23) (2026-06-11)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* organization identifiers ([#88](https://github.com/iotaledger/twin-auditable-item-graph/issues/88)) ([c58d35b](https://github.com/iotaledger/twin-auditable-item-graph/commit/c58d35bd5b878da0fa02862797c70b61e4f2a469))
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Dependencies
|
|
12
|
+
|
|
13
|
+
* The following workspace dependencies were updated
|
|
14
|
+
* dependencies
|
|
15
|
+
* @twin.org/auditable-item-graph-models bumped from 0.0.3-next.22 to 0.0.3-next.23
|
|
16
|
+
|
|
17
|
+
## [0.0.3-next.22](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-service-v0.0.3-next.21...auditable-item-graph-service-v0.0.3-next.22) (2026-06-09)
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
### Bug Fixes
|
|
21
|
+
|
|
22
|
+
* implement removeProof on AuditableItemGraphRestClient and expose DELETE /:id/proof route ([#85](https://github.com/iotaledger/twin-auditable-item-graph/issues/85)) ([ed74458](https://github.com/iotaledger/twin-auditable-item-graph/commit/ed74458aff9bc8606b75657a7bff15af4884189e))
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
### Dependencies
|
|
26
|
+
|
|
27
|
+
* The following workspace dependencies were updated
|
|
28
|
+
* dependencies
|
|
29
|
+
* @twin.org/auditable-item-graph-models bumped from 0.0.3-next.21 to 0.0.3-next.22
|
|
30
|
+
|
|
3
31
|
## [0.0.3-next.21](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-service-v0.0.3-next.20...auditable-item-graph-service-v0.0.3-next.21) (2026-06-03)
|
|
4
32
|
|
|
5
33
|
|
package/docs/open-api/spec.json
CHANGED
|
@@ -1791,6 +1791,95 @@
|
|
|
1791
1791
|
}
|
|
1792
1792
|
}
|
|
1793
1793
|
}
|
|
1794
|
+
},
|
|
1795
|
+
"/auditable-item-graph/{id}/proof": {
|
|
1796
|
+
"delete": {
|
|
1797
|
+
"operationId": "auditableItemGraphRemoveProof",
|
|
1798
|
+
"summary": "Remove the notarization proof from all changesets of a graph vertex",
|
|
1799
|
+
"tags": [
|
|
1800
|
+
"Auditable Item Graph"
|
|
1801
|
+
],
|
|
1802
|
+
"parameters": [
|
|
1803
|
+
{
|
|
1804
|
+
"name": "id",
|
|
1805
|
+
"description": "The id of the vertex whose proof should be removed.",
|
|
1806
|
+
"in": "path",
|
|
1807
|
+
"required": true,
|
|
1808
|
+
"schema": {
|
|
1809
|
+
"type": "string"
|
|
1810
|
+
},
|
|
1811
|
+
"style": "simple",
|
|
1812
|
+
"example": "0101010101010101010101010101010101010101010101010101010101010101"
|
|
1813
|
+
}
|
|
1814
|
+
],
|
|
1815
|
+
"security": [
|
|
1816
|
+
{
|
|
1817
|
+
"jwtBearerAuthScheme": []
|
|
1818
|
+
}
|
|
1819
|
+
],
|
|
1820
|
+
"responses": {
|
|
1821
|
+
"204": {
|
|
1822
|
+
"description": "The rest request ended in success with no data."
|
|
1823
|
+
},
|
|
1824
|
+
"400": {
|
|
1825
|
+
"description": "The server cannot process the request, see the content for more details.",
|
|
1826
|
+
"content": {
|
|
1827
|
+
"application/json": {
|
|
1828
|
+
"schema": {
|
|
1829
|
+
"$ref": "#/components/schemas/Error"
|
|
1830
|
+
},
|
|
1831
|
+
"examples": {
|
|
1832
|
+
"exampleResponse": {
|
|
1833
|
+
"value": {
|
|
1834
|
+
"name": "GeneralError",
|
|
1835
|
+
"message": "errorMessage",
|
|
1836
|
+
"properties": {
|
|
1837
|
+
"foo": "bar"
|
|
1838
|
+
}
|
|
1839
|
+
}
|
|
1840
|
+
}
|
|
1841
|
+
}
|
|
1842
|
+
}
|
|
1843
|
+
}
|
|
1844
|
+
},
|
|
1845
|
+
"401": {
|
|
1846
|
+
"description": "You are not authorized to use the API or no credentials were supplied, see the content for more details.",
|
|
1847
|
+
"content": {
|
|
1848
|
+
"application/json": {
|
|
1849
|
+
"schema": {
|
|
1850
|
+
"$ref": "#/components/schemas/Error"
|
|
1851
|
+
},
|
|
1852
|
+
"examples": {
|
|
1853
|
+
"exampleResponse": {
|
|
1854
|
+
"value": {
|
|
1855
|
+
"name": "UnauthorizedError",
|
|
1856
|
+
"message": "errorMessage"
|
|
1857
|
+
}
|
|
1858
|
+
}
|
|
1859
|
+
}
|
|
1860
|
+
}
|
|
1861
|
+
}
|
|
1862
|
+
},
|
|
1863
|
+
"500": {
|
|
1864
|
+
"description": "The server has encountered a situation it does not know how to handle, see the content for more details.",
|
|
1865
|
+
"content": {
|
|
1866
|
+
"application/json": {
|
|
1867
|
+
"schema": {
|
|
1868
|
+
"$ref": "#/components/schemas/Error"
|
|
1869
|
+
},
|
|
1870
|
+
"examples": {
|
|
1871
|
+
"exampleResponse": {
|
|
1872
|
+
"value": {
|
|
1873
|
+
"name": "InternalServerError",
|
|
1874
|
+
"message": "errorMessage"
|
|
1875
|
+
}
|
|
1876
|
+
}
|
|
1877
|
+
}
|
|
1878
|
+
}
|
|
1879
|
+
}
|
|
1880
|
+
}
|
|
1881
|
+
}
|
|
1882
|
+
}
|
|
1794
1883
|
}
|
|
1795
1884
|
},
|
|
1796
1885
|
"components": {
|
|
@@ -22,9 +22,9 @@ The id of the vertex.
|
|
|
22
22
|
|
|
23
23
|
***
|
|
24
24
|
|
|
25
|
-
### organizationIdentity
|
|
25
|
+
### organizationIdentity {#organizationidentity}
|
|
26
26
|
|
|
27
|
-
>
|
|
27
|
+
> **organizationIdentity**: `string`
|
|
28
28
|
|
|
29
29
|
The identity of the organization which controls the vertex.
|
|
30
30
|
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Function: auditableItemGraphRemoveProof()
|
|
2
|
+
|
|
3
|
+
> **auditableItemGraphRemoveProof**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
|
|
4
|
+
|
|
5
|
+
Remove the notarization proof from all changesets of a graph vertex.
|
|
6
|
+
|
|
7
|
+
## Parameters
|
|
8
|
+
|
|
9
|
+
### httpRequestContext
|
|
10
|
+
|
|
11
|
+
`IHttpRequestContext`
|
|
12
|
+
|
|
13
|
+
The request context for the API.
|
|
14
|
+
|
|
15
|
+
### componentName
|
|
16
|
+
|
|
17
|
+
`string`
|
|
18
|
+
|
|
19
|
+
The name of the component to use in the routes.
|
|
20
|
+
|
|
21
|
+
### request
|
|
22
|
+
|
|
23
|
+
`IAuditableItemGraphRemoveProofRequest`
|
|
24
|
+
|
|
25
|
+
The request.
|
|
26
|
+
|
|
27
|
+
## Returns
|
|
28
|
+
|
|
29
|
+
`Promise`\<`INoContentResponse`\>
|
|
30
|
+
|
|
31
|
+
The response object with additional http response properties.
|
package/docs/reference/index.md
CHANGED
|
@@ -31,5 +31,6 @@
|
|
|
31
31
|
- [auditableItemGraphUpdatePartial](functions/auditableItemGraphUpdatePartial.md)
|
|
32
32
|
- [auditableItemGraphList](functions/auditableItemGraphList.md)
|
|
33
33
|
- [auditableItemGraphVersionGet](functions/auditableItemGraphVersionGet.md)
|
|
34
|
+
- [auditableItemGraphRemoveProof](functions/auditableItemGraphRemoveProof.md)
|
|
34
35
|
- [auditableItemGraphVersionList](functions/auditableItemGraphVersionList.md)
|
|
35
36
|
- [initSchema](functions/initSchema.md)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/auditable-item-graph-service",
|
|
3
|
-
"version": "0.0.3-next.
|
|
3
|
+
"version": "0.0.3-next.23",
|
|
4
4
|
"description": "Implements graph lifecycle operations and audited change tracking with API route definitions.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
},
|
|
16
16
|
"dependencies": {
|
|
17
17
|
"@twin.org/api-models": "next",
|
|
18
|
-
"@twin.org/auditable-item-graph-models": "0.0.3-next.
|
|
18
|
+
"@twin.org/auditable-item-graph-models": "0.0.3-next.23",
|
|
19
19
|
"@twin.org/context": "next",
|
|
20
20
|
"@twin.org/core": "next",
|
|
21
21
|
"@twin.org/crypto": "next",
|