@twin.org/auditable-item-graph-models 0.9.0-next.1 → 0.9.0-next.2
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/models/IAuditableItemGraphComponent.js.map +1 -1
- package/dist/es/models/api/IAuditableItemGraphListRequest.js.map +1 -1
- package/dist/types/models/IAuditableItemGraphComponent.d.ts +2 -2
- package/dist/types/models/api/IAuditableItemGraphListRequest.d.ts +1 -1
- package/docs/changelog.md +7 -0
- package/docs/reference/interfaces/IAuditableItemGraphComponent.md +1 -1
- package/docs/reference/interfaces/IAuditableItemGraphListRequest.md +1 -1
- package/package.json +10 -10
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IAuditableItemGraphComponent.js","sourceRoot":"","sources":["../../../src/models/IAuditableItemGraphComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type {
|
|
1
|
+
{"version":3,"file":"IAuditableItemGraphComponent.js","sourceRoot":"","sources":["../../../src/models/IAuditableItemGraphComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { EntityCondition, SortDirection } from \"@twin.org/entity\";\nimport type { IAuditableItemGraphChangeset } from \"./IAuditableItemGraphChangeset.js\";\nimport type { IAuditableItemGraphChangesetList } from \"./IAuditableItemGraphChangesetList.js\";\nimport type { IAuditableItemGraphPartialVertex } from \"./IAuditableItemGraphPartialVertex.js\";\nimport type { IAuditableItemGraphVertex } from \"./IAuditableItemGraphVertex.js\";\nimport type { IAuditableItemGraphVertexList } from \"./IAuditableItemGraphVertexList.js\";\nimport type { IAuditableItemGraphVertexVersionList } from \"./IAuditableItemGraphVertexVersionList.js\";\nimport type { VerifyDepth } from \"./verifyDepth.js\";\n\n/**\n * Interface describing an auditable item graph contract.\n */\nexport interface IAuditableItemGraphComponent extends IComponent {\n\t/**\n\t * Create a new graph vertex.\n\t * @param vertex The vertex to create.\n\t * @param vertex.annotationObject The annotation object for the vertex as JSON-LD.\n\t * @param vertex.aliases Alternative aliases that can be used to identify the vertex.\n\t * @param vertex.resources The resources attached to the vertex.\n\t * @param vertex.edges The edges connected to the vertex.\n\t * @returns The id of the new graph item.\n\t */\n\tcreate(vertex: Omit<IAuditableItemGraphVertex, \"id\">): Promise<string>;\n\n\t/**\n\t * Update a graph vertex (PUT — full replacement of vertex state).\n\t * Concurrent updates for the same vertex are serialized via `Mutex` on the vertex id.\n\t * Multi-replica deployments are not coordinated.\n\t * @param vertex The vertex to update.\n\t * @param vertex.id The id of the vertex to update.\n\t * @param vertex.annotationObject The annotation object for the vertex as JSON-LD.\n\t * @param vertex.aliases Alternative aliases that can be used to identify the vertex.\n\t * @param vertex.resources The resources attached to the vertex.\n\t * @param vertex.edges The edges connected to the vertex.\n\t * @returns A promise that resolves when the vertex has been updated.\n\t */\n\tupdate(vertex: IAuditableItemGraphVertex): Promise<void>;\n\n\t/**\n\t * Partially update a graph vertex (PATCH); only properties that are not undefined are applied.\n\t * Sub-lists use explicit `{ add, remove }` patch objects. Serialized with `update()` via `Mutex`\n\t * on the same vertex id.\n\t * @param partial The partial vertex update (must include `id`).\n\t * @returns A promise that resolves when the partial update has been applied.\n\t */\n\tupdatePartial(partial: IAuditableItemGraphPartialVertex): Promise<void>;\n\n\t/**\n\t * Get a graph vertex.\n\t * @param id The id of the vertex to get.\n\t * @param options Additional options for the get operation.\n\t * @param options.includeDeleted Whether to include deleted aliases, resource, edges, defaults to false.\n\t * @param options.verifySignatureDepth How many signatures to verify, defaults to \"none\".\n\t * @returns The vertex if found.\n\t * @throws NotFoundError if the vertex is not found.\n\t */\n\tget(\n\t\tid: string,\n\t\toptions?: {\n\t\t\tincludeDeleted?: boolean;\n\t\t\tverifySignatureDepth?: VerifyDepth;\n\t\t}\n\t): Promise<IAuditableItemGraphVertex>;\n\n\t/**\n\t * Get a graph vertex changeset list.\n\t * @param id The id of the vertex to get.\n\t * @param cursor The optional cursor to get next chunk.\n\t * @param limit Limit the number of entities to return.\n\t * @param options Additional options for the get operation.\n\t * @param options.verifySignatureDepth How many signatures to verify, defaults to \"none\".\n\t * @returns The changeset if found.\n\t * @throws NotFoundError if the vertex is not found.\n\t */\n\tgetChangesets(\n\t\tid: string,\n\t\tcursor?: string,\n\t\tlimit?: number,\n\t\toptions?: {\n\t\t\tverifySignatureDepth?: VerifyDepth;\n\t\t}\n\t): Promise<{\n\t\tchangesets: IAuditableItemGraphChangesetList;\n\t\tcursor?: string;\n\t}>;\n\n\t/**\n\t * Get a graph vertex changeset.\n\t * @param id The id of the vertex to get.\n\t * @param options Additional options for the get operation.\n\t * @param options.verifySignatureDepth How many signatures to verify, defaults to \"none\".\n\t * @returns The changeset if found.\n\t * @throws NotFoundError if the vertex or changeset is not found.\n\t */\n\tgetChangeset(\n\t\tid: string,\n\t\toptions?: { verifySignatureDepth?: VerifyDepth }\n\t): Promise<IAuditableItemGraphChangeset>;\n\n\t/**\n\t * Get a graph vertex at a specific version.\n\t * @param id The id of the vertex.\n\t * @param version The version number to retrieve.\n\t * @returns The vertex reconstructed at that version.\n\t * @throws NotFoundError if the vertex or version is not found.\n\t */\n\tgetVersion(id: string, version: number): Promise<IAuditableItemGraphVertex>;\n\n\t/**\n\t * Get all versions of a graph vertex.\n\t * @param id The id of the vertex.\n\t * @param options Additional options for the operation.\n\t * @param options.after Only return versions created after this ISO 8601 timestamp (exclusive).\n\t * @param options.before Only return versions created before this ISO 8601 timestamp (exclusive).\n\t * @returns The list of vertex versions.\n\t * @throws NotFoundError if the vertex is not found.\n\t */\n\tgetVersions(\n\t\tid: string,\n\t\toptions?: {\n\t\t\tafter?: string;\n\t\t\tbefore?: string;\n\t\t}\n\t): Promise<IAuditableItemGraphVertexVersionList>;\n\n\t/**\n\t * Remove the proof for an item.\n\t * @param id The id of the vertex to remove the proof from.\n\t * @returns A promise that resolves when the proof has been removed from all changesets.\n\t * @throws NotFoundError if the vertex is not found.\n\t */\n\tremoveProof(id: string): Promise<void>;\n\n\t/**\n\t * Query the graph for vertices.\n\t * @param options The query options.\n\t * @param options.id The optional id to look for.\n\t * @param options.idMode Look in id, alias or both, defaults to both.\n\t * @param options.idExact Find only exact matches, default to false meaning partial matching.\n\t * @param options.resourceTypes Include vertices with specific resource types.\n\t * @param conditions Conditions to use in the query.\n\t * @param orderBy The order for the results, defaults to dateCreated.\n\t * @param orderByDirection The direction for the order, defaults to descending.\n\t * @param properties The properties to return, if not provided defaults to id, dateCreated, aliases and object.\n\t * @param cursor The cursor to request the next chunk of entities.\n\t * @param limit Limit the number of entities to return.\n\t * @returns The entities, which can be partial if a limited keys list was provided.\n\t */\n\tquery(\n\t\toptions?: {\n\t\t\tid?: string;\n\t\t\tidMode?: \"id\" | \"alias\" | \"both\";\n\t\t\tidExact?: boolean;\n\t\t\tresourceTypes?: string[];\n\t\t},\n\t\tconditions?: EntityCondition<IAuditableItemGraphVertex>,\n\t\torderBy?: keyof Pick<IAuditableItemGraphVertex, \"dateCreated\" | \"dateModified\">,\n\t\torderByDirection?: SortDirection,\n\t\tproperties?: (keyof IAuditableItemGraphVertex)[],\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\tentries: IAuditableItemGraphVertexList;\n\t\tcursor?: string;\n\t}>;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IAuditableItemGraphListRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IAuditableItemGraphListRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { SortDirection } from \"@twin.org/entity\";\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\nimport type { IAuditableItemGraphVertex } from \"../IAuditableItemGraphVertex.js\";\n\n/**\n * Get the a list of the vertices with matching ids or aliases.\n */\nexport interface IAuditableItemGraphListRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The query parameters.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * The id or alias to try and find.\n\t\t */\n\t\tid?: string;\n\n\t\t/**\n\t\t * Which field to look in with the id, defaults to both.\n\t\t */\n\t\tidMode?: \"id\" | \"alias\" | \"both\";\n\n\t\t/**\n\t\t * Find only exact matches, default to false meaning partial matching.\n\t\t */\n\t\tidExact?: string;\n\n\t\t/**\n\t\t * Include vertices with specific resource types, comma separated.\n\t\t */\n\t\tresourceTypes?: string;\n\n\t\t/**\n\t\t * The conditions to filter the streams, JSON stringified
|
|
1
|
+
{"version":3,"file":"IAuditableItemGraphListRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IAuditableItemGraphListRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { SortDirection } from \"@twin.org/entity\";\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\nimport type { IAuditableItemGraphVertex } from \"../IAuditableItemGraphVertex.js\";\n\n/**\n * Get the a list of the vertices with matching ids or aliases.\n */\nexport interface IAuditableItemGraphListRequest {\n\t/**\n\t * The headers which can be used to determine the response data type.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The query parameters.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * The id or alias to try and find.\n\t\t */\n\t\tid?: string;\n\n\t\t/**\n\t\t * Which field to look in with the id, defaults to both.\n\t\t */\n\t\tidMode?: \"id\" | \"alias\" | \"both\";\n\n\t\t/**\n\t\t * Find only exact matches, default to false meaning partial matching.\n\t\t */\n\t\tidExact?: string;\n\n\t\t/**\n\t\t * Include vertices with specific resource types, comma separated.\n\t\t */\n\t\tresourceTypes?: string;\n\n\t\t/**\n\t\t * The conditions to filter the streams, JSON stringified EntityCondition<IAuditableItemGraphVertex>.\n\t\t */\n\t\tconditions?: string;\n\n\t\t/**\n\t\t * The order for the results, default to dateCreated.\n\t\t */\n\t\torderBy?: keyof Pick<IAuditableItemGraphVertex, \"dateCreated\" | \"dateModified\">;\n\n\t\t/**\n\t\t * The direction for the order, defaults to desc.\n\t\t */\n\t\torderByDirection?: SortDirection;\n\n\t\t/**\n\t\t * The properties to return as a comma separated list, defaults to \"id,dateCreated,aliases,annotationObject\".\n\t\t */\n\t\tproperties?: string;\n\n\t\t/**\n\t\t * The optional cursor to get next chunk.\n\t\t */\n\t\tcursor?: string;\n\n\t\t/**\n\t\t * Limit the number of entities to return.\n\t\t */\n\t\tlimit?: string;\n\t};\n}\n"]}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { IComponent } from "@twin.org/core";
|
|
2
|
-
import type {
|
|
2
|
+
import type { EntityCondition, SortDirection } from "@twin.org/entity";
|
|
3
3
|
import type { IAuditableItemGraphChangeset } from "./IAuditableItemGraphChangeset.js";
|
|
4
4
|
import type { IAuditableItemGraphChangesetList } from "./IAuditableItemGraphChangesetList.js";
|
|
5
5
|
import type { IAuditableItemGraphPartialVertex } from "./IAuditableItemGraphPartialVertex.js";
|
|
@@ -130,7 +130,7 @@ export interface IAuditableItemGraphComponent extends IComponent {
|
|
|
130
130
|
idMode?: "id" | "alias" | "both";
|
|
131
131
|
idExact?: boolean;
|
|
132
132
|
resourceTypes?: string[];
|
|
133
|
-
}, conditions?:
|
|
133
|
+
}, conditions?: EntityCondition<IAuditableItemGraphVertex>, orderBy?: keyof Pick<IAuditableItemGraphVertex, "dateCreated" | "dateModified">, orderByDirection?: SortDirection, properties?: (keyof IAuditableItemGraphVertex)[], cursor?: string, limit?: number): Promise<{
|
|
134
134
|
entries: IAuditableItemGraphVertexList;
|
|
135
135
|
cursor?: string;
|
|
136
136
|
}>;
|
|
@@ -32,7 +32,7 @@ export interface IAuditableItemGraphListRequest {
|
|
|
32
32
|
*/
|
|
33
33
|
resourceTypes?: string;
|
|
34
34
|
/**
|
|
35
|
-
* The conditions to filter the streams, JSON stringified
|
|
35
|
+
* The conditions to filter the streams, JSON stringified EntityCondition<IAuditableItemGraphVertex>.
|
|
36
36
|
*/
|
|
37
37
|
conditions?: string;
|
|
38
38
|
/**
|
package/docs/changelog.md
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [0.9.0-next.2](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.9.0-next.1...auditable-item-graph-models-v0.9.0-next.2) (2026-06-25)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* additional query conditions ([#100](https://github.com/iotaledger/twin-auditable-item-graph/issues/100)) ([4fc6b7a](https://github.com/iotaledger/twin-auditable-item-graph/commit/4fc6b7afd7a854806537954fcd334619304da49c))
|
|
9
|
+
|
|
3
10
|
## [0.9.0-next.1](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.9.0-next.0...auditable-item-graph-models-v0.9.0-next.1) (2026-06-24)
|
|
4
11
|
|
|
5
12
|
|
|
@@ -50,7 +50,7 @@ Include vertices with specific resource types, comma separated.
|
|
|
50
50
|
|
|
51
51
|
> `optional` **conditions?**: `string`
|
|
52
52
|
|
|
53
|
-
The conditions to filter the streams, JSON stringified
|
|
53
|
+
The conditions to filter the streams, JSON stringified EntityCondition<IAuditableItemGraphVertex>.
|
|
54
54
|
|
|
55
55
|
#### orderBy?
|
|
56
56
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@twin.org/auditable-item-graph-models",
|
|
3
|
-
"version": "0.9.0-next.
|
|
3
|
+
"version": "0.9.0-next.2",
|
|
4
4
|
"description": "Defines shared graph data contracts, JSON schemas, and JSON-LD contexts for consistent interoperability.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -14,15 +14,15 @@
|
|
|
14
14
|
"node": ">=20.0.0"
|
|
15
15
|
},
|
|
16
16
|
"dependencies": {
|
|
17
|
-
"@twin.org/core": "
|
|
18
|
-
"@twin.org/data-core": "
|
|
19
|
-
"@twin.org/data-json-ld": "
|
|
20
|
-
"@twin.org/entity": "
|
|
21
|
-
"@twin.org/immutable-proof-models": "
|
|
22
|
-
"@twin.org/nameof": "
|
|
23
|
-
"@twin.org/standards-schema-org": "
|
|
24
|
-
"@twin.org/telemetry-models": "
|
|
25
|
-
"@twin.org/web": "
|
|
17
|
+
"@twin.org/core": "next",
|
|
18
|
+
"@twin.org/data-core": "next",
|
|
19
|
+
"@twin.org/data-json-ld": "next",
|
|
20
|
+
"@twin.org/entity": "next",
|
|
21
|
+
"@twin.org/immutable-proof-models": "next",
|
|
22
|
+
"@twin.org/nameof": "next",
|
|
23
|
+
"@twin.org/standards-schema-org": "next",
|
|
24
|
+
"@twin.org/telemetry-models": "next",
|
|
25
|
+
"@twin.org/web": "next"
|
|
26
26
|
},
|
|
27
27
|
"main": "./dist/es/index.js",
|
|
28
28
|
"types": "./dist/types/index.d.ts",
|