@twin.org/auditable-item-graph-models 0.0.1-next.31 → 0.0.1-next.33
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 +7 -4
- package/dist/esm/index.mjs +7 -4
- package/dist/types/models/IAuditableItemGraphComponent.d.ts +4 -4
- package/dist/types/models/IAuditableItemGraphEdge.d.ts +2 -2
- package/dist/types/models/api/IAuditableItemGraphCreateRequest.d.ts +1 -1
- package/dist/types/models/api/IAuditableItemGraphUpdateRequest.d.ts +1 -1
- package/docs/changelog.md +1 -1
- package/docs/reference/interfaces/IAuditableItemGraphComponent.md +3 -3
- package/docs/reference/interfaces/IAuditableItemGraphEdge.md +3 -3
- package/package.json +1 -1
package/dist/cjs/index.cjs
CHANGED
|
@@ -228,16 +228,19 @@ var properties$4 = {
|
|
|
228
228
|
$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
|
|
229
229
|
description: "The JSON-LD annotation object for the edge."
|
|
230
230
|
},
|
|
231
|
-
|
|
232
|
-
type: "
|
|
233
|
-
|
|
231
|
+
edgeRelationships: {
|
|
232
|
+
type: "array",
|
|
233
|
+
items: {
|
|
234
|
+
type: "string"
|
|
235
|
+
},
|
|
236
|
+
description: "The relationships between the two vertices."
|
|
234
237
|
}
|
|
235
238
|
};
|
|
236
239
|
var required$4 = [
|
|
237
240
|
"@context",
|
|
238
241
|
"id",
|
|
239
242
|
"type",
|
|
240
|
-
"
|
|
243
|
+
"edgeRelationships"
|
|
241
244
|
];
|
|
242
245
|
var additionalProperties$4 = false;
|
|
243
246
|
var description$4 = "Interface describing an edge between two vertices in an auditable item graph.";
|
package/dist/esm/index.mjs
CHANGED
|
@@ -226,16 +226,19 @@ var properties$4 = {
|
|
|
226
226
|
$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
|
|
227
227
|
description: "The JSON-LD annotation object for the edge."
|
|
228
228
|
},
|
|
229
|
-
|
|
230
|
-
type: "
|
|
231
|
-
|
|
229
|
+
edgeRelationships: {
|
|
230
|
+
type: "array",
|
|
231
|
+
items: {
|
|
232
|
+
type: "string"
|
|
233
|
+
},
|
|
234
|
+
description: "The relationships between the two vertices."
|
|
232
235
|
}
|
|
233
236
|
};
|
|
234
237
|
var required$4 = [
|
|
235
238
|
"@context",
|
|
236
239
|
"id",
|
|
237
240
|
"type",
|
|
238
|
-
"
|
|
241
|
+
"edgeRelationships"
|
|
239
242
|
];
|
|
240
243
|
var additionalProperties$4 = false;
|
|
241
244
|
var description$4 = "Interface describing an edge between two vertices in an auditable item graph.";
|
|
@@ -32,7 +32,7 @@ export interface IAuditableItemGraphComponent extends IComponent {
|
|
|
32
32
|
}[];
|
|
33
33
|
edges?: {
|
|
34
34
|
id: string;
|
|
35
|
-
|
|
35
|
+
edgeRelationships: string[];
|
|
36
36
|
annotationObject?: IJsonLdNodeObject;
|
|
37
37
|
}[];
|
|
38
38
|
}, userIdentity?: string, nodeIdentity?: string): Promise<string>;
|
|
@@ -62,7 +62,7 @@ export interface IAuditableItemGraphComponent extends IComponent {
|
|
|
62
62
|
}[];
|
|
63
63
|
edges?: {
|
|
64
64
|
id: string;
|
|
65
|
-
|
|
65
|
+
edgeRelationships: string[];
|
|
66
66
|
annotationObject?: IJsonLdNodeObject;
|
|
67
67
|
}[];
|
|
68
68
|
}, userIdentity?: string, nodeIdentity?: string): Promise<void>;
|
|
@@ -82,13 +82,13 @@ export interface IAuditableItemGraphComponent extends IComponent {
|
|
|
82
82
|
verifySignatureDepth?: VerifyDepth;
|
|
83
83
|
}): Promise<IAuditableItemGraphVertex>;
|
|
84
84
|
/**
|
|
85
|
-
* Remove the
|
|
85
|
+
* Remove the verifiable storage for an item.
|
|
86
86
|
* @param id The id of the vertex to remove the storage from.
|
|
87
87
|
* @param nodeIdentity The node identity to use for vault operations.
|
|
88
88
|
* @returns Nothing.
|
|
89
89
|
* @throws NotFoundError if the vertex is not found.
|
|
90
90
|
*/
|
|
91
|
-
|
|
91
|
+
removeVerifiable(id: string, nodeIdentity?: string): Promise<void>;
|
|
92
92
|
/**
|
|
93
93
|
* Query the graph for vertices.
|
|
94
94
|
* @param options The query options.
|
|
@@ -23,7 +23,7 @@ export interface IAuditableItemGraphEdge extends IAuditableItemGraphAuditedEleme
|
|
|
23
23
|
*/
|
|
24
24
|
annotationObject?: IJsonLdNodeObject;
|
|
25
25
|
/**
|
|
26
|
-
* The
|
|
26
|
+
* The relationships between the two vertices.
|
|
27
27
|
*/
|
|
28
|
-
|
|
28
|
+
edgeRelationships: string[];
|
|
29
29
|
}
|
package/docs/changelog.md
CHANGED
|
@@ -174,11 +174,11 @@ NotFoundError if the vertex is not found.
|
|
|
174
174
|
|
|
175
175
|
***
|
|
176
176
|
|
|
177
|
-
###
|
|
177
|
+
### removeVerifiable()
|
|
178
178
|
|
|
179
|
-
> **
|
|
179
|
+
> **removeVerifiable**(`id`, `nodeIdentity`?): `Promise`\<`void`\>
|
|
180
180
|
|
|
181
|
-
Remove the
|
|
181
|
+
Remove the verifiable storage for an item.
|
|
182
182
|
|
|
183
183
|
#### Parameters
|
|
184
184
|
|
|
@@ -80,8 +80,8 @@ The JSON-LD annotation object for the edge.
|
|
|
80
80
|
|
|
81
81
|
***
|
|
82
82
|
|
|
83
|
-
###
|
|
83
|
+
### edgeRelationships
|
|
84
84
|
|
|
85
|
-
> **
|
|
85
|
+
> **edgeRelationships**: `string`[]
|
|
86
86
|
|
|
87
|
-
The
|
|
87
|
+
The relationships between the two vertices.
|
package/package.json
CHANGED