@twin.org/auditable-item-graph-models 0.0.3-next.13 → 0.0.3-next.15

package/dist/es/index.js

@@ -11,7 +11,13 @@ export * from "./models/api/IAuditableItemGraphGetResponse.js";
 export * from "./models/api/IAuditableItemGraphListRequest.js";
 export * from "./models/api/IAuditableItemGraphListResponse.js";
 export * from "./models/api/IAuditableItemGraphUpdateRequest.js";
+export * from "./models/api/IAuditableItemGraphVersionGetRequest.js";
+export * from "./models/api/IAuditableItemGraphVersionGetResponse.js";
+export * from "./models/api/IAuditableItemGraphVersionListRequest.js";
+export * from "./models/api/IAuditableItemGraphVersionListResponse.js";
 export * from "./models/auditableItemGraphContexts.js";
+export * from "./models/auditableItemGraphMetricIds.js";
+export * from "./models/auditableItemGraphMetrics.js";
 export * from "./models/auditableItemGraphTopics.js";
 export * from "./models/auditableItemGraphTypes.js";
 export * from "./models/eventBus/IAuditableItemGraphEventBusVertexCreated.js";
@@ -26,5 +32,6 @@ export * from "./models/IAuditableItemGraphPatchOperation.js";
 export * from "./models/IAuditableItemGraphResource.js";
 export * from "./models/IAuditableItemGraphVertex.js";
 export * from "./models/IAuditableItemGraphVertexList.js";
+export * from "./models/IAuditableItemGraphVertexVersionList.js";
 export * from "./models/verifyDepth.js";
 //# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,4CAA4C,CAAC;AAC3D,cAAc,wDAAwD,CAAC;AACvE,cAAc,yDAAyD,CAAC;AACxE,cAAc,yDAAyD,CAAC;AACxE,cAAc,0DAA0D,CAAC;AACzE,cAAc,kDAAkD,CAAC;AACjE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,iDAAiD,CAAC;AAChE,cAAc,kDAAkD,CAAC;AACjE,cAAc,wCAAwC,CAAC;AACvD,cAAc,sCAAsC,CAAC;AACrD,cAAc,qCAAqC,CAAC;AACpD,cAAc,+DAA+D,CAAC;AAC9E,cAAc,+DAA+D,CAAC;AAC9E,cAAc,sCAAsC,CAAC;AACrD,cAAc,+CAA+C,CAAC;AAC9D,cAAc,0CAA0C,CAAC;AACzD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,0CAA0C,CAAC;AACzD,cAAc,qCAAqC,CAAC;AACpD,cAAc,+CAA+C,CAAC;AAC9D,cAAc,yCAAyC,CAAC;AACxD,cAAc,uCAAuC,CAAC;AACtD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,yBAAyB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./dataTypes/auditableItemGraphDataTypes.js\";\nexport * from \"./models/api/IAuditableItemGraphChangesetGetRequest.js\";\nexport * from \"./models/api/IAuditableItemGraphChangesetGetResponse.js\";\nexport * from \"./models/api/IAuditableItemGraphChangesetListRequest.js\";\nexport * from \"./models/api/IAuditableItemGraphChangesetListResponse.js\";\nexport * from \"./models/api/IAuditableItemGraphCreateRequest.js\";\nexport * from \"./models/api/IAuditableItemGraphGetRequest.js\";\nexport * from \"./models/api/IAuditableItemGraphGetResponse.js\";\nexport * from \"./models/api/IAuditableItemGraphListRequest.js\";\nexport * from \"./models/api/IAuditableItemGraphListResponse.js\";\nexport * from \"./models/api/IAuditableItemGraphUpdateRequest.js\";\nexport * from \"./models/auditableItemGraphContexts.js\";\nexport * from \"./models/auditableItemGraphTopics.js\";\nexport * from \"./models/auditableItemGraphTypes.js\";\nexport * from \"./models/eventBus/IAuditableItemGraphEventBusVertexCreated.js\";\nexport * from \"./models/eventBus/IAuditableItemGraphEventBusVertexUpdated.js\";\nexport * from \"./models/IAuditableItemGraphAlias.js\";\nexport * from \"./models/IAuditableItemGraphAuditedElement.js\";\nexport * from \"./models/IAuditableItemGraphChangeset.js\";\nexport * from \"./models/IAuditableItemGraphChangesetList.js\";\nexport * from \"./models/IAuditableItemGraphComponent.js\";\nexport * from \"./models/IAuditableItemGraphEdge.js\";\nexport * from \"./models/IAuditableItemGraphPatchOperation.js\";\nexport * from \"./models/IAuditableItemGraphResource.js\";\nexport * from \"./models/IAuditableItemGraphVertex.js\";\nexport * from \"./models/IAuditableItemGraphVertexList.js\";\nexport * from \"./models/verifyDepth.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,4CAA4C,CAAC;AAC3D,cAAc,wDAAwD,CAAC;AACvE,cAAc,yDAAyD,CAAC;AACxE,cAAc,yDAAyD,CAAC;AACxE,cAAc,0DAA0D,CAAC;AACzE,cAAc,kDAAkD,CAAC;AACjE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,iDAAiD,CAAC;AAChE,cAAc,kDAAkD,CAAC;AACjE,cAAc,sDAAsD,CAAC;AACrE,cAAc,uDAAuD,CAAC;AACtE,cAAc,uDAAuD,CAAC;AACtE,cAAc,wDAAwD,CAAC;AACvE,cAAc,wCAAwC,CAAC;AACvD,cAAc,yCAAyC,CAAC;AACxD,cAAc,uCAAuC,CAAC;AACtD,cAAc,sCAAsC,CAAC;AACrD,cAAc,qCAAqC,CAAC;AACpD,cAAc,+DAA+D,CAAC;AAC9E,cAAc,+DAA+D,CAAC;AAC9E,cAAc,sCAAsC,CAAC;AACrD,cAAc,+CAA+C,CAAC;AAC9D,cAAc,0CAA0C,CAAC;AACzD,cAAc,8CAA8C,CAAC;AAC7D,cAAc,0CAA0C,CAAC;AACzD,cAAc,qCAAqC,CAAC;AACpD,cAAc,+CAA+C,CAAC;AAC9D,cAAc,yCAAyC,CAAC;AACxD,cAAc,uCAAuC,CAAC;AACtD,cAAc,2CAA2C,CAAC;AAC1D,cAAc,kDAAkD,CAAC;AACjE,cAAc,yBAAyB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./dataTypes/auditableItemGraphDataTypes.js\";\nexport * from \"./models/api/IAuditableItemGraphChangesetGetRequest.js\";\nexport * from \"./models/api/IAuditableItemGraphChangesetGetResponse.js\";\nexport * from \"./models/api/IAuditableItemGraphChangesetListRequest.js\";\nexport * from \"./models/api/IAuditableItemGraphChangesetListResponse.js\";\nexport * from \"./models/api/IAuditableItemGraphCreateRequest.js\";\nexport * from \"./models/api/IAuditableItemGraphGetRequest.js\";\nexport * from \"./models/api/IAuditableItemGraphGetResponse.js\";\nexport * from \"./models/api/IAuditableItemGraphListRequest.js\";\nexport * from \"./models/api/IAuditableItemGraphListResponse.js\";\nexport * from \"./models/api/IAuditableItemGraphUpdateRequest.js\";\nexport * from \"./models/api/IAuditableItemGraphVersionGetRequest.js\";\nexport * from \"./models/api/IAuditableItemGraphVersionGetResponse.js\";\nexport * from \"./models/api/IAuditableItemGraphVersionListRequest.js\";\nexport * from \"./models/api/IAuditableItemGraphVersionListResponse.js\";\nexport * from \"./models/auditableItemGraphContexts.js\";\nexport * from \"./models/auditableItemGraphMetricIds.js\";\nexport * from \"./models/auditableItemGraphMetrics.js\";\nexport * from \"./models/auditableItemGraphTopics.js\";\nexport * from \"./models/auditableItemGraphTypes.js\";\nexport * from \"./models/eventBus/IAuditableItemGraphEventBusVertexCreated.js\";\nexport * from \"./models/eventBus/IAuditableItemGraphEventBusVertexUpdated.js\";\nexport * from \"./models/IAuditableItemGraphAlias.js\";\nexport * from \"./models/IAuditableItemGraphAuditedElement.js\";\nexport * from \"./models/IAuditableItemGraphChangeset.js\";\nexport * from \"./models/IAuditableItemGraphChangesetList.js\";\nexport * from \"./models/IAuditableItemGraphComponent.js\";\nexport * from \"./models/IAuditableItemGraphEdge.js\";\nexport * from \"./models/IAuditableItemGraphPatchOperation.js\";\nexport * from \"./models/IAuditableItemGraphResource.js\";\nexport * from \"./models/IAuditableItemGraphVertex.js\";\nexport * from \"./models/IAuditableItemGraphVertexList.js\";\nexport * from \"./models/IAuditableItemGraphVertexVersionList.js\";\nexport * from \"./models/verifyDepth.js\";\n"]}

package/dist/es/models/IAuditableItemGraphChangeset.js.map

@@ -1 +1 @@
-{"version":3,"file":"IAuditableItemGraphChangeset.js","sourceRoot":"","sources":["../../../src/models/IAuditableItemGraphChangeset.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdContextDefinitionElement } from \"@twin.org/data-json-ld\";\nimport type { IImmutableProofVerification } from \"@twin.org/immutable-proof-models\";\nimport type { AuditableItemGraphContexts } from \"./auditableItemGraphContexts.js\";\nimport type { AuditableItemGraphTypes } from \"./auditableItemGraphTypes.js\";\nimport type { IAuditableItemGraphPatchOperation } from \"./IAuditableItemGraphPatchOperation.js\";\n\n/**\n * Interface describing a set of changes to the vertex.\n */\nexport interface IAuditableItemGraphChangeset {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\"?: [\n\t\ttypeof AuditableItemGraphContexts.Context,\n\t\ttypeof AuditableItemGraphContexts.ContextCommon,\n\t\t...IJsonLdContextDefinitionElement[]\n\t];\n\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype: typeof AuditableItemGraphTypes.Changeset;\n\n\t/**\n\t * The id of the changeset.\n\t */\n\tid: string;\n\n\t/**\n\t * The date/time of when the changeset was created.\n\t * @json-ld namespace:sch\n\t */\n\tdateCreated: string;\n\n\t/**\n\t * The user identity that created the changes.\n\t * @json-ld namespace:twin-common\n\t */\n\tuserIdentity?: string;\n\n\t/**\n\t * The patches in the changeset.\n\t * @json-ld container:set\n\t */\n\tpatches: IAuditableItemGraphPatchOperation[];\n\n\t/**\n\t * The immutable proof id which contains the signature for this changeset.\n\t * @json-ld type:sch:identifier\n\t */\n\tproofId?: string;\n\n\t/**\n\t * The verification for the changeset.\n\t * @json-ld id\n\t */\n\tverification?: IImmutableProofVerification;\n}\n"]}
+{"version":3,"file":"IAuditableItemGraphChangeset.js","sourceRoot":"","sources":["../../../src/models/IAuditableItemGraphChangeset.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdContextDefinitionElement } from \"@twin.org/data-json-ld\";\nimport type { IImmutableProofVerification } from \"@twin.org/immutable-proof-models\";\nimport type { AuditableItemGraphContexts } from \"./auditableItemGraphContexts.js\";\nimport type { AuditableItemGraphTypes } from \"./auditableItemGraphTypes.js\";\nimport type { IAuditableItemGraphPatchOperation } from \"./IAuditableItemGraphPatchOperation.js\";\n\n/**\n * Interface describing a set of changes to the vertex.\n */\nexport interface IAuditableItemGraphChangeset {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\"?: [\n\t\ttypeof AuditableItemGraphContexts.Context,\n\t\ttypeof AuditableItemGraphContexts.ContextCommon,\n\t\t...IJsonLdContextDefinitionElement[]\n\t];\n\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype: typeof AuditableItemGraphTypes.Changeset;\n\n\t/**\n\t * The id of the changeset.\n\t */\n\tid: string;\n\n\t/**\n\t * The date/time of when the changeset was created.\n\t * @json-ld namespace:sch\n\t */\n\tdateCreated: string;\n\n\t/**\n\t * The user identity that created the changes.\n\t * @json-ld namespace:twin-common\n\t */\n\tuserIdentity?: string;\n\n\t/**\n\t * The patches in the changeset.\n\t * @json-ld container:set\n\t */\n\tpatches: IAuditableItemGraphPatchOperation[];\n\n\t/**\n\t * The immutable proof id which contains the signature for this changeset.\n\t * @json-ld type:sch:identifier\n\t */\n\tproofId?: string;\n\n\t/**\n\t * The verification for the changeset.\n\t * @json-ld id\n\t */\n\tverification?: IImmutableProofVerification;\n\n\t/**\n\t * The version number of the vertex after this changeset was applied.\n\t * Maps to https://schema.org/version.\n\t * @json-ld namespace:sch\n\t */\n\tversion?: number;\n}\n"]}

package/dist/es/models/IAuditableItemGraphComponent.js.map

@@ -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 { IComparator, SortDirection } from \"@twin.org/entity\";\nimport type { IAuditableItemGraphChangeset } from \"./IAuditableItemGraphChangeset.js\";\nimport type { IAuditableItemGraphChangesetList } from \"./IAuditableItemGraphChangesetList.js\";\nimport type { IAuditableItemGraphVertex } from \"./IAuditableItemGraphVertex.js\";\nimport type { IAuditableItemGraphVertexList } from \"./IAuditableItemGraphVertexList.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.\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 Nothing.\n\t */\n\tupdate(vertex: IAuditableItemGraphVertex): 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 * Remove the verifiable storage for an item.\n\t * @param id The id of the vertex to remove the storage from.\n\t * @returns Nothing.\n\t * @throws NotFoundError if the vertex is not found.\n\t */\n\tremoveVerifiable(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?: IComparator[],\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"]}
+{"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 { IComparator, SortDirection } from \"@twin.org/entity\";\nimport type { IAuditableItemGraphChangeset } from \"./IAuditableItemGraphChangeset.js\";\nimport type { IAuditableItemGraphChangesetList } from \"./IAuditableItemGraphChangesetList.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.\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 Nothing.\n\t */\n\tupdate(vertex: IAuditableItemGraphVertex): 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 versionId The id of the version (changeset id) 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, versionId: string): 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 verifiable storage for an item.\n\t * @param id The id of the vertex to remove the storage from.\n\t * @returns Nothing.\n\t * @throws NotFoundError if the vertex is not found.\n\t */\n\tremoveVerifiable(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?: IComparator[],\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"]}

package/dist/es/models/IAuditableItemGraphVertex.js.map

@@ -1 +1 @@
-{"version":3,"file":"IAuditableItemGraphVertex.js","sourceRoot":"","sources":["../../../src/models/IAuditableItemGraphVertex.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { AuditableItemGraphContexts } from \"./auditableItemGraphContexts.js\";\nimport type { AuditableItemGraphTypes } from \"./auditableItemGraphTypes.js\";\nimport type { IAuditableItemGraphAlias } from \"./IAuditableItemGraphAlias.js\";\nimport type { IAuditableItemGraphAuditedElement } from \"./IAuditableItemGraphAuditedElement.js\";\nimport type { IAuditableItemGraphEdge } from \"./IAuditableItemGraphEdge.js\";\nimport type { IAuditableItemGraphResource } from \"./IAuditableItemGraphResource.js\";\n\n/**\n * Interface describing an auditable item graph vertex.\n */\nexport interface IAuditableItemGraphVertex extends Omit<\n\tIAuditableItemGraphAuditedElement,\n\t\"deleted\"\n> {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\": [\n\t\ttypeof AuditableItemGraphContexts.Context,\n\t\ttypeof AuditableItemGraphContexts.ContextCommon,\n\t\t...IJsonLdContextDefinitionElement[]\n\t];\n\n\t/**\n\t * The id of the element.\n\t */\n\tid: string;\n\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype: typeof AuditableItemGraphTypes.Vertex;\n\n\t/**\n\t * The identity of the organization which controls the vertex.\n\t * @json-ld namespace:twin-common\n\t */\n\torganizationIdentity?: string;\n\n\t/**\n\t * The JSON-LD annotation object for the vertex.\n\t * @json-ld namespace:twin-common\n\t */\n\tannotationObject?: IJsonLdNodeObject;\n\n\t/**\n\t * Alternative aliases that can be used to identify the vertex.\n\t * @json-ld container:set\n\t */\n\taliases?: IAuditableItemGraphAlias[];\n\n\t/**\n\t * The resources attached to the vertex.\n\t * @json-ld container:set\n\t */\n\tresources?: IAuditableItemGraphResource[];\n\n\t/**\n\t * Edges connected to the vertex.\n\t * @json-ld container:set\n\t */\n\tedges?: IAuditableItemGraphEdge[];\n\n\t/**\n\t * Is the vertex verified, will only be populated when verification is requested.\n\t * @json-ld namespace:twin-common\n\t */\n\tverified?: boolean;\n}\n"]}
+{"version":3,"file":"IAuditableItemGraphVertex.js","sourceRoot":"","sources":["../../../src/models/IAuditableItemGraphVertex.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type { AuditableItemGraphContexts } from \"./auditableItemGraphContexts.js\";\nimport type { AuditableItemGraphTypes } from \"./auditableItemGraphTypes.js\";\nimport type { IAuditableItemGraphAlias } from \"./IAuditableItemGraphAlias.js\";\nimport type { IAuditableItemGraphAuditedElement } from \"./IAuditableItemGraphAuditedElement.js\";\nimport type { IAuditableItemGraphEdge } from \"./IAuditableItemGraphEdge.js\";\nimport type { IAuditableItemGraphResource } from \"./IAuditableItemGraphResource.js\";\n\n/**\n * Interface describing an auditable item graph vertex.\n */\nexport interface IAuditableItemGraphVertex extends Omit<\n\tIAuditableItemGraphAuditedElement,\n\t\"deleted\"\n> {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\": [\n\t\ttypeof AuditableItemGraphContexts.Context,\n\t\ttypeof AuditableItemGraphContexts.ContextCommon,\n\t\t...IJsonLdContextDefinitionElement[]\n\t];\n\n\t/**\n\t * The id of the element.\n\t */\n\tid: string;\n\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype: typeof AuditableItemGraphTypes.Vertex;\n\n\t/**\n\t * The identity of the organization which controls the vertex.\n\t * @json-ld namespace:twin-common\n\t */\n\torganizationIdentity?: string;\n\n\t/**\n\t * The JSON-LD annotation object for the vertex.\n\t * @json-ld namespace:twin-common\n\t */\n\tannotationObject?: IJsonLdNodeObject;\n\n\t/**\n\t * Alternative aliases that can be used to identify the vertex.\n\t * @json-ld container:set\n\t */\n\taliases?: IAuditableItemGraphAlias[];\n\n\t/**\n\t * The resources attached to the vertex.\n\t * @json-ld container:set\n\t */\n\tresources?: IAuditableItemGraphResource[];\n\n\t/**\n\t * Edges connected to the vertex.\n\t * @json-ld container:set\n\t */\n\tedges?: IAuditableItemGraphEdge[];\n\n\t/**\n\t * Is the vertex verified, will only be populated when verification is requested.\n\t * @json-ld namespace:twin-common\n\t */\n\tverified?: boolean;\n\n\t/**\n\t * The version of the vertex, populated only when getting a specific version.\n\t * Maps to https://schema.org/version.\n\t * @json-ld namespace:sch\n\t */\n\tversion?: number;\n}\n"]}

package/dist/es/models/IAuditableItemGraphVertexVersionList.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IAuditableItemGraphVertexVersionList.js.map

package/dist/es/models/IAuditableItemGraphVertexVersionList.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAuditableItemGraphVertexVersionList.js","sourceRoot":"","sources":["../../../src/models/IAuditableItemGraphVertexVersionList.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdContextDefinitionElement } from \"@twin.org/data-json-ld\";\nimport type { SchemaOrgContexts, SchemaOrgTypes } from \"@twin.org/standards-schema-org\";\nimport type { AuditableItemGraphContexts } from \"./auditableItemGraphContexts.js\";\nimport type { AuditableItemGraphTypes } from \"./auditableItemGraphTypes.js\";\n\n/**\n * Interface describing a list of auditable item graph vertex version numbers.\n */\nexport interface IAuditableItemGraphVertexVersionList {\n\t/**\n\t * JSON-LD Context.\n\t */\n\t\"@context\": [\n\t\ttypeof SchemaOrgContexts.Context,\n\t\ttypeof AuditableItemGraphContexts.Context,\n\t\t...IJsonLdContextDefinitionElement[]\n\t];\n\n\t/**\n\t * JSON-LD Type.\n\t */\n\ttype: [typeof SchemaOrgTypes.ItemList, typeof AuditableItemGraphTypes.VertexVersionList];\n\n\t/**\n\t * The list of version numbers.\n\t * @json-ld namespace:sch\n\t */\n\t[SchemaOrgTypes.ItemListElement]: number[];\n}\n"]}

package/dist/es/models/api/IAuditableItemGraphVersionGetRequest.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IAuditableItemGraphVersionGetRequest.js.map

package/dist/es/models/api/IAuditableItemGraphVersionGetRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAuditableItemGraphVersionGetRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IAuditableItemGraphVersionGetRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * Get an auditable item graph vertex at a specific version.\n */\nexport interface IAuditableItemGraphVersionGetRequest {\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 parameters from the path.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the vertex.\n\t\t */\n\t\tid: string;\n\n\t\t/**\n\t\t * The id of the version (changeset id) to get.\n\t\t */\n\t\tversionId: string;\n\t};\n}\n"]}

package/dist/es/models/api/IAuditableItemGraphVersionGetResponse.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IAuditableItemGraphVersionGetResponse.js.map

package/dist/es/models/api/IAuditableItemGraphVersionGetResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAuditableItemGraphVersionGetResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IAuditableItemGraphVersionGetResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\nimport type { IAuditableItemGraphVertex } from \"../IAuditableItemGraphVertex.js\";\n\n/**\n * Response to getting an auditable item graph vertex at a specific version.\n */\nexport interface IAuditableItemGraphVersionGetResponse {\n\t/**\n\t * The headers.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The response body.\n\t */\n\tbody: IAuditableItemGraphVertex;\n}\n"]}

package/dist/es/models/api/IAuditableItemGraphVersionListRequest.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IAuditableItemGraphVersionListRequest.js.map

package/dist/es/models/api/IAuditableItemGraphVersionListRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAuditableItemGraphVersionListRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IAuditableItemGraphVersionListRequest.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * Get all versions of an auditable item graph vertex.\n */\nexport interface IAuditableItemGraphVersionListRequest {\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 parameters from the path.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the vertex.\n\t\t */\n\t\tid: string;\n\t};\n\n\t/**\n\t * The query parameters.\n\t */\n\tquery?: {\n\t\t/**\n\t\t * Only return versions created after this ISO 8601 timestamp (exclusive).\n\t\t */\n\t\tafter?: string;\n\n\t\t/**\n\t\t * Only return versions created before this ISO 8601 timestamp (exclusive).\n\t\t */\n\t\tbefore?: string;\n\t};\n}\n"]}

package/dist/es/models/api/IAuditableItemGraphVersionListResponse.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IAuditableItemGraphVersionListResponse.js.map

package/dist/es/models/api/IAuditableItemGraphVersionListResponse.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAuditableItemGraphVersionListResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IAuditableItemGraphVersionListResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { HeaderTypes, MimeTypes } from \"@twin.org/web\";\nimport type { IAuditableItemGraphVertexVersionList } from \"../IAuditableItemGraphVertexVersionList.js\";\n\n/**\n * Response to getting all versions of an auditable item graph vertex.\n */\nexport interface IAuditableItemGraphVersionListResponse {\n\t/**\n\t * The headers.\n\t */\n\theaders?: {\n\t\t[HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;\n\t};\n\n\t/**\n\t * The response body.\n\t */\n\tbody: IAuditableItemGraphVertexVersionList;\n}\n"]}

package/dist/es/models/auditableItemGraphMetricIds.js

@@ -0,0 +1,69 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Metric IDs for the auditable item graph service.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const AuditableItemGraphMetricIds = {
+    /**
+     * Number of vertices created.
+     */
+    VerticesCreated: "aig_vertices_created",
+    /**
+     * Number of vertices updated.
+     */
+    VerticesUpdated: "aig_vertices_updated",
+    /**
+     * Number of changesets created.
+     */
+    ChangesetsCreated: "aig_changesets_created",
+    /**
+     * Number of aliases added.
+     */
+    AliasesAdded: "aig_aliases_added",
+    /**
+     * Number of aliases modified.
+     */
+    AliasesModified: "aig_aliases_modified",
+    /**
+     * Number of aliases deleted.
+     */
+    AliasesDeleted: "aig_aliases_deleted",
+    /**
+     * Number of resources added.
+     */
+    ResourcesAdded: "aig_resources_added",
+    /**
+     * Number of resources modified.
+     */
+    ResourcesModified: "aig_resources_modified",
+    /**
+     * Number of resources deleted.
+     */
+    ResourcesDeleted: "aig_resources_deleted",
+    /**
+     * Number of edges added.
+     */
+    EdgesAdded: "aig_edges_added",
+    /**
+     * Number of edges modified.
+     */
+    EdgesModified: "aig_edges_modified",
+    /**
+     * Number of edges deleted.
+     */
+    EdgesDeleted: "aig_edges_deleted",
+    /**
+     * Number of queries executed.
+     */
+    QueriesExecuted: "aig_queries_executed",
+    /**
+     * Number of verifications succeeded.
+     */
+    VerificationsSucceeded: "aig_verifications_succeeded",
+    /**
+     * Number of verifications failed.
+     */
+    VerificationsFailed: "aig_verifications_failed"
+};
+//# sourceMappingURL=auditableItemGraphMetricIds.js.map

package/dist/es/models/auditableItemGraphMetricIds.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auditableItemGraphMetricIds.js","sourceRoot":"","sources":["../../../src/models/auditableItemGraphMetricIds.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,2BAA2B,GAAG;IAC1C;;OAEG;IACH,eAAe,EAAE,sBAAsB;IAEvC;;OAEG;IACH,eAAe,EAAE,sBAAsB;IAEvC;;OAEG;IACH,iBAAiB,EAAE,wBAAwB;IAE3C;;OAEG;IACH,YAAY,EAAE,mBAAmB;IAEjC;;OAEG;IACH,eAAe,EAAE,sBAAsB;IAEvC;;OAEG;IACH,cAAc,EAAE,qBAAqB;IAErC;;OAEG;IACH,cAAc,EAAE,qBAAqB;IAErC;;OAEG;IACH,iBAAiB,EAAE,wBAAwB;IAE3C;;OAEG;IACH,gBAAgB,EAAE,uBAAuB;IAEzC;;OAEG;IACH,UAAU,EAAE,iBAAiB;IAE7B;;OAEG;IACH,aAAa,EAAE,oBAAoB;IAEnC;;OAEG;IACH,YAAY,EAAE,mBAAmB;IAEjC;;OAEG;IACH,eAAe,EAAE,sBAAsB;IAEvC;;OAEG;IACH,sBAAsB,EAAE,6BAA6B;IAErD;;OAEG;IACH,mBAAmB,EAAE,0BAA0B;CACtC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Metric IDs for the auditable item graph service.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const AuditableItemGraphMetricIds = {\n\t/**\n\t * Number of vertices created.\n\t */\n\tVerticesCreated: \"aig_vertices_created\",\n\n\t/**\n\t * Number of vertices updated.\n\t */\n\tVerticesUpdated: \"aig_vertices_updated\",\n\n\t/**\n\t * Number of changesets created.\n\t */\n\tChangesetsCreated: \"aig_changesets_created\",\n\n\t/**\n\t * Number of aliases added.\n\t */\n\tAliasesAdded: \"aig_aliases_added\",\n\n\t/**\n\t * Number of aliases modified.\n\t */\n\tAliasesModified: \"aig_aliases_modified\",\n\n\t/**\n\t * Number of aliases deleted.\n\t */\n\tAliasesDeleted: \"aig_aliases_deleted\",\n\n\t/**\n\t * Number of resources added.\n\t */\n\tResourcesAdded: \"aig_resources_added\",\n\n\t/**\n\t * Number of resources modified.\n\t */\n\tResourcesModified: \"aig_resources_modified\",\n\n\t/**\n\t * Number of resources deleted.\n\t */\n\tResourcesDeleted: \"aig_resources_deleted\",\n\n\t/**\n\t * Number of edges added.\n\t */\n\tEdgesAdded: \"aig_edges_added\",\n\n\t/**\n\t * Number of edges modified.\n\t */\n\tEdgesModified: \"aig_edges_modified\",\n\n\t/**\n\t * Number of edges deleted.\n\t */\n\tEdgesDeleted: \"aig_edges_deleted\",\n\n\t/**\n\t * Number of queries executed.\n\t */\n\tQueriesExecuted: \"aig_queries_executed\",\n\n\t/**\n\t * Number of verifications succeeded.\n\t */\n\tVerificationsSucceeded: \"aig_verifications_succeeded\",\n\n\t/**\n\t * Number of verifications failed.\n\t */\n\tVerificationsFailed: \"aig_verifications_failed\"\n} as const;\n\n/**\n * Metric IDs for the auditable item graph service.\n */\nexport type AuditableItemGraphMetricIds =\n\t(typeof AuditableItemGraphMetricIds)[keyof typeof AuditableItemGraphMetricIds];\n"]}

package/dist/es/models/auditableItemGraphMetrics.js

@@ -0,0 +1,82 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { MetricType } from "@twin.org/telemetry-models";
+import { AuditableItemGraphMetricIds } from "./auditableItemGraphMetricIds.js";
+/**
+ * Metrics registered by the auditable item graph service.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const AuditableItemGraphMetrics = [
+    {
+        id: AuditableItemGraphMetricIds.VerticesCreated,
+        label: "Vertices created",
+        type: MetricType.Counter
+    },
+    {
+        id: AuditableItemGraphMetricIds.VerticesUpdated,
+        label: "Vertices updated",
+        type: MetricType.Counter
+    },
+    {
+        id: AuditableItemGraphMetricIds.ChangesetsCreated,
+        label: "Changesets created",
+        type: MetricType.Counter
+    },
+    {
+        id: AuditableItemGraphMetricIds.AliasesAdded,
+        label: "Aliases added",
+        type: MetricType.Counter
+    },
+    {
+        id: AuditableItemGraphMetricIds.AliasesModified,
+        label: "Aliases modified",
+        type: MetricType.Counter
+    },
+    {
+        id: AuditableItemGraphMetricIds.AliasesDeleted,
+        label: "Aliases deleted",
+        type: MetricType.Counter
+    },
+    {
+        id: AuditableItemGraphMetricIds.ResourcesAdded,
+        label: "Resources added",
+        type: MetricType.Counter
+    },
+    {
+        id: AuditableItemGraphMetricIds.ResourcesModified,
+        label: "Resources modified",
+        type: MetricType.Counter
+    },
+    {
+        id: AuditableItemGraphMetricIds.ResourcesDeleted,
+        label: "Resources deleted",
+        type: MetricType.Counter
+    },
+    { id: AuditableItemGraphMetricIds.EdgesAdded, label: "Edges added", type: MetricType.Counter },
+    {
+        id: AuditableItemGraphMetricIds.EdgesModified,
+        label: "Edges modified",
+        type: MetricType.Counter
+    },
+    {
+        id: AuditableItemGraphMetricIds.EdgesDeleted,
+        label: "Edges deleted",
+        type: MetricType.Counter
+    },
+    {
+        id: AuditableItemGraphMetricIds.QueriesExecuted,
+        label: "Queries executed",
+        type: MetricType.Counter
+    },
+    {
+        id: AuditableItemGraphMetricIds.VerificationsSucceeded,
+        label: "Verifications succeeded",
+        type: MetricType.Counter
+    },
+    {
+        id: AuditableItemGraphMetricIds.VerificationsFailed,
+        label: "Verifications failed",
+        type: MetricType.Counter
+    }
+];
+//# sourceMappingURL=auditableItemGraphMetrics.js.map

package/dist/es/models/auditableItemGraphMetrics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"auditableItemGraphMetrics.js","sourceRoot":"","sources":["../../../src/models/auditableItemGraphMetrics.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAyB,UAAU,EAAE,MAAM,4BAA4B,CAAC;AAC/E,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAE/E;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,yBAAyB,GAAuB;IAC5D;QACC,EAAE,EAAE,2BAA2B,CAAC,eAAe;QAC/C,KAAK,EAAE,kBAAkB;QACzB,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,2BAA2B,CAAC,eAAe;QAC/C,KAAK,EAAE,kBAAkB;QACzB,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,2BAA2B,CAAC,iBAAiB;QACjD,KAAK,EAAE,oBAAoB;QAC3B,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,2BAA2B,CAAC,YAAY;QAC5C,KAAK,EAAE,eAAe;QACtB,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,2BAA2B,CAAC,eAAe;QAC/C,KAAK,EAAE,kBAAkB;QACzB,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,2BAA2B,CAAC,cAAc;QAC9C,KAAK,EAAE,iBAAiB;QACxB,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,2BAA2B,CAAC,cAAc;QAC9C,KAAK,EAAE,iBAAiB;QACxB,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,2BAA2B,CAAC,iBAAiB;QACjD,KAAK,EAAE,oBAAoB;QAC3B,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,2BAA2B,CAAC,gBAAgB;QAChD,KAAK,EAAE,mBAAmB;QAC1B,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD,EAAE,EAAE,EAAE,2BAA2B,CAAC,UAAU,EAAE,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,UAAU,CAAC,OAAO,EAAE;IAC9F;QACC,EAAE,EAAE,2BAA2B,CAAC,aAAa;QAC7C,KAAK,EAAE,gBAAgB;QACvB,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,2BAA2B,CAAC,YAAY;QAC5C,KAAK,EAAE,eAAe;QACtB,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,2BAA2B,CAAC,eAAe;QAC/C,KAAK,EAAE,kBAAkB;QACzB,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,2BAA2B,CAAC,sBAAsB;QACtD,KAAK,EAAE,yBAAyB;QAChC,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;IACD;QACC,EAAE,EAAE,2BAA2B,CAAC,mBAAmB;QACnD,KAAK,EAAE,sBAAsB;QAC7B,IAAI,EAAE,UAAU,CAAC,OAAO;KACxB;CACD,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { type ITelemetryMetric, MetricType } from \"@twin.org/telemetry-models\";\nimport { AuditableItemGraphMetricIds } from \"./auditableItemGraphMetricIds.js\";\n\n/**\n * Metrics registered by the auditable item graph service.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const AuditableItemGraphMetrics: ITelemetryMetric[] = [\n\t{\n\t\tid: AuditableItemGraphMetricIds.VerticesCreated,\n\t\tlabel: \"Vertices created\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: AuditableItemGraphMetricIds.VerticesUpdated,\n\t\tlabel: \"Vertices updated\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: AuditableItemGraphMetricIds.ChangesetsCreated,\n\t\tlabel: \"Changesets created\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: AuditableItemGraphMetricIds.AliasesAdded,\n\t\tlabel: \"Aliases added\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: AuditableItemGraphMetricIds.AliasesModified,\n\t\tlabel: \"Aliases modified\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: AuditableItemGraphMetricIds.AliasesDeleted,\n\t\tlabel: \"Aliases deleted\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: AuditableItemGraphMetricIds.ResourcesAdded,\n\t\tlabel: \"Resources added\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: AuditableItemGraphMetricIds.ResourcesModified,\n\t\tlabel: \"Resources modified\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: AuditableItemGraphMetricIds.ResourcesDeleted,\n\t\tlabel: \"Resources deleted\",\n\t\ttype: MetricType.Counter\n\t},\n\t{ id: AuditableItemGraphMetricIds.EdgesAdded, label: \"Edges added\", type: MetricType.Counter },\n\t{\n\t\tid: AuditableItemGraphMetricIds.EdgesModified,\n\t\tlabel: \"Edges modified\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: AuditableItemGraphMetricIds.EdgesDeleted,\n\t\tlabel: \"Edges deleted\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: AuditableItemGraphMetricIds.QueriesExecuted,\n\t\tlabel: \"Queries executed\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: AuditableItemGraphMetricIds.VerificationsSucceeded,\n\t\tlabel: \"Verifications succeeded\",\n\t\ttype: MetricType.Counter\n\t},\n\t{\n\t\tid: AuditableItemGraphMetricIds.VerificationsFailed,\n\t\tlabel: \"Verifications failed\",\n\t\ttype: MetricType.Counter\n\t}\n];\n"]}

package/dist/es/models/auditableItemGraphTypes.js

@@ -36,6 +36,10 @@ export const AuditableItemGraphTypes = {
     /**
      * Represents patch operation.
      */
-    PatchOperation: "AuditableItemGraphPatchOperation"
+    PatchOperation: "AuditableItemGraphPatchOperation",
+    /**
+     * Represents auditable item graph vertex version list.
+     */
+    VertexVersionList: "AuditableItemGraphVertexVersionList"
 };
 //# sourceMappingURL=auditableItemGraphTypes.js.map

package/dist/es/models/auditableItemGraphTypes.js.map

@@ -1 +1 @@
-{"version":3,"file":"auditableItemGraphTypes.js","sourceRoot":"","sources":["../../../src/models/auditableItemGraphTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACtC;;OAEG;IACH,MAAM,EAAE,0BAA0B;IAElC;;OAEG;IACH,UAAU,EAAE,8BAA8B;IAE1C;;OAEG;IACH,KAAK,EAAE,yBAAyB;IAEhC;;OAEG;IACH,QAAQ,EAAE,4BAA4B;IAEtC;;OAEG;IACH,IAAI,EAAE,wBAAwB;IAE9B;;OAEG;IACH,SAAS,EAAE,6BAA6B;IAExC;;OAEG;IACH,aAAa,EAAE,iCAAiC;IAEhD;;OAEG;IACH,cAAc,EAAE,kCAAkC;CACzC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The types of auditable item graph data.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const AuditableItemGraphTypes = {\n\t/**\n\t * Represents auditable item graph vertex.\n\t */\n\tVertex: \"AuditableItemGraphVertex\",\n\n\t/**\n\t * Represents auditable item graph vertex list.\n\t */\n\tVertexList: \"AuditableItemGraphVertexList\",\n\n\t/**\n\t * Represents auditable item graph alias.\n\t */\n\tAlias: \"AuditableItemGraphAlias\",\n\n\t/**\n\t * Represents auditable item graph resource.\n\t */\n\tResource: \"AuditableItemGraphResource\",\n\n\t/**\n\t * Represents auditable item graph edge.\n\t */\n\tEdge: \"AuditableItemGraphEdge\",\n\n\t/**\n\t * Represents auditable item graph changeset.\n\t */\n\tChangeset: \"AuditableItemGraphChangeset\",\n\n\t/**\n\t * Represents auditable item graph changeset list.\n\t */\n\tChangesetList: \"AuditableItemGraphChangesetList\",\n\n\t/**\n\t * Represents patch operation.\n\t */\n\tPatchOperation: \"AuditableItemGraphPatchOperation\"\n} as const;\n\n/**\n * The types of auditable item graph data.\n */\nexport type AuditableItemGraphTypes =\n\t(typeof AuditableItemGraphTypes)[keyof typeof AuditableItemGraphTypes];\n"]}
+{"version":3,"file":"auditableItemGraphTypes.js","sourceRoot":"","sources":["../../../src/models/auditableItemGraphTypes.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACtC;;OAEG;IACH,MAAM,EAAE,0BAA0B;IAElC;;OAEG;IACH,UAAU,EAAE,8BAA8B;IAE1C;;OAEG;IACH,KAAK,EAAE,yBAAyB;IAEhC;;OAEG;IACH,QAAQ,EAAE,4BAA4B;IAEtC;;OAEG;IACH,IAAI,EAAE,wBAAwB;IAE9B;;OAEG;IACH,SAAS,EAAE,6BAA6B;IAExC;;OAEG;IACH,aAAa,EAAE,iCAAiC;IAEhD;;OAEG;IACH,cAAc,EAAE,kCAAkC;IAElD;;OAEG;IACH,iBAAiB,EAAE,qCAAqC;CAC/C,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The types of auditable item graph data.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const AuditableItemGraphTypes = {\n\t/**\n\t * Represents auditable item graph vertex.\n\t */\n\tVertex: \"AuditableItemGraphVertex\",\n\n\t/**\n\t * Represents auditable item graph vertex list.\n\t */\n\tVertexList: \"AuditableItemGraphVertexList\",\n\n\t/**\n\t * Represents auditable item graph alias.\n\t */\n\tAlias: \"AuditableItemGraphAlias\",\n\n\t/**\n\t * Represents auditable item graph resource.\n\t */\n\tResource: \"AuditableItemGraphResource\",\n\n\t/**\n\t * Represents auditable item graph edge.\n\t */\n\tEdge: \"AuditableItemGraphEdge\",\n\n\t/**\n\t * Represents auditable item graph changeset.\n\t */\n\tChangeset: \"AuditableItemGraphChangeset\",\n\n\t/**\n\t * Represents auditable item graph changeset list.\n\t */\n\tChangesetList: \"AuditableItemGraphChangesetList\",\n\n\t/**\n\t * Represents patch operation.\n\t */\n\tPatchOperation: \"AuditableItemGraphPatchOperation\",\n\n\t/**\n\t * Represents auditable item graph vertex version list.\n\t */\n\tVertexVersionList: \"AuditableItemGraphVertexVersionList\"\n} as const;\n\n/**\n * The types of auditable item graph data.\n */\nexport type AuditableItemGraphTypes =\n\t(typeof AuditableItemGraphTypes)[keyof typeof AuditableItemGraphTypes];\n"]}

package/dist/es/schemas/AuditableItemGraphChangeset.json

@@ -51,6 +51,10 @@
         "verification": {
             "$ref": "https://schema.twindev.org/immutable-proof/ImmutableProofVerification",
             "description": "The verification for the changeset."
+        },
+        "version": {
+            "type": "number",
+            "description": "The version number of the vertex after this changeset was applied.\nMaps to https://schema.org/version."
         }
     },
     "required": [

package/dist/es/schemas/AuditableItemGraphVertex.json

@@ -61,6 +61,10 @@
         "verified": {
             "type": "boolean",
             "description": "Is the vertex verified, will only be populated when verification is requested."
+        },
+        "version": {
+            "type": "number",
+            "description": "The version of the vertex, populated only when getting a specific version.\nMaps to https://schema.org/version."
         }
     },
     "required": [

package/dist/types/index.d.ts

@@ -9,7 +9,13 @@ export * from "./models/api/IAuditableItemGraphGetResponse.js";
 export * from "./models/api/IAuditableItemGraphListRequest.js";
 export * from "./models/api/IAuditableItemGraphListResponse.js";
 export * from "./models/api/IAuditableItemGraphUpdateRequest.js";
+export * from "./models/api/IAuditableItemGraphVersionGetRequest.js";
+export * from "./models/api/IAuditableItemGraphVersionGetResponse.js";
+export * from "./models/api/IAuditableItemGraphVersionListRequest.js";
+export * from "./models/api/IAuditableItemGraphVersionListResponse.js";
 export * from "./models/auditableItemGraphContexts.js";
+export * from "./models/auditableItemGraphMetricIds.js";
+export * from "./models/auditableItemGraphMetrics.js";
 export * from "./models/auditableItemGraphTopics.js";
 export * from "./models/auditableItemGraphTypes.js";
 export * from "./models/eventBus/IAuditableItemGraphEventBusVertexCreated.js";
@@ -24,4 +30,5 @@ export * from "./models/IAuditableItemGraphPatchOperation.js";
 export * from "./models/IAuditableItemGraphResource.js";
 export * from "./models/IAuditableItemGraphVertex.js";
 export * from "./models/IAuditableItemGraphVertexList.js";
+export * from "./models/IAuditableItemGraphVertexVersionList.js";
 export * from "./models/verifyDepth.js";

package/dist/types/models/IAuditableItemGraphChangeset.d.ts

@@ -48,4 +48,10 @@ export interface IAuditableItemGraphChangeset {
      * @json-ld id
      */
     verification?: IImmutableProofVerification;
+    /**
+     * The version number of the vertex after this changeset was applied.
+     * Maps to https://schema.org/version.
+     * @json-ld namespace:sch
+     */
+    version?: number;
 }

package/dist/types/models/IAuditableItemGraphComponent.d.ts

@@ -4,6 +4,7 @@ import type { IAuditableItemGraphChangeset } from "./IAuditableItemGraphChangese
 import type { IAuditableItemGraphChangesetList } from "./IAuditableItemGraphChangesetList.js";
 import type { IAuditableItemGraphVertex } from "./IAuditableItemGraphVertex.js";
 import type { IAuditableItemGraphVertexList } from "./IAuditableItemGraphVertexList.js";
+import type { IAuditableItemGraphVertexVersionList } from "./IAuditableItemGraphVertexVersionList.js";
 import type { VerifyDepth } from "./verifyDepth.js";
 /**
  * Interface describing an auditable item graph contract.
@@ -70,6 +71,27 @@ export interface IAuditableItemGraphComponent extends IComponent {
     getChangeset(id: string, options?: {
         verifySignatureDepth?: VerifyDepth;
     }): Promise<IAuditableItemGraphChangeset>;
+    /**
+     * Get a graph vertex at a specific version.
+     * @param id The id of the vertex.
+     * @param versionId The id of the version (changeset id) to retrieve.
+     * @returns The vertex reconstructed at that version.
+     * @throws NotFoundError if the vertex or version is not found.
+     */
+    getVersion(id: string, versionId: string): Promise<IAuditableItemGraphVertex>;
+    /**
+     * Get all versions of a graph vertex.
+     * @param id The id of the vertex.
+     * @param options Additional options for the operation.
+     * @param options.after Only return versions created after this ISO 8601 timestamp (exclusive).
+     * @param options.before Only return versions created before this ISO 8601 timestamp (exclusive).
+     * @returns The list of vertex versions.
+     * @throws NotFoundError if the vertex is not found.
+     */
+    getVersions(id: string, options?: {
+        after?: string;
+        before?: string;
+    }): Promise<IAuditableItemGraphVertexVersionList>;
     /**
      * Remove the verifiable storage for an item.
      * @param id The id of the vertex to remove the storage from.

package/dist/types/models/IAuditableItemGraphVertex.d.ts

@@ -55,4 +55,10 @@ export interface IAuditableItemGraphVertex extends Omit<IAuditableItemGraphAudit
      * @json-ld namespace:twin-common
      */
     verified?: boolean;
+    /**
+     * The version of the vertex, populated only when getting a specific version.
+     * Maps to https://schema.org/version.
+     * @json-ld namespace:sch
+     */
+    version?: number;
 }

package/dist/types/models/IAuditableItemGraphVertexVersionList.d.ts

@@ -0,0 +1,26 @@
+import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
+import type { SchemaOrgContexts, SchemaOrgTypes } from "@twin.org/standards-schema-org";
+import type { AuditableItemGraphContexts } from "./auditableItemGraphContexts.js";
+import type { AuditableItemGraphTypes } from "./auditableItemGraphTypes.js";
+/**
+ * Interface describing a list of auditable item graph vertex version numbers.
+ */
+export interface IAuditableItemGraphVertexVersionList {
+    /**
+     * JSON-LD Context.
+     */
+    "@context": [
+        typeof SchemaOrgContexts.Context,
+        typeof AuditableItemGraphContexts.Context,
+        ...IJsonLdContextDefinitionElement[]
+    ];
+    /**
+     * JSON-LD Type.
+     */
+    type: [typeof SchemaOrgTypes.ItemList, typeof AuditableItemGraphTypes.VertexVersionList];
+    /**
+     * The list of version numbers.
+     * @json-ld namespace:sch
+     */
+    [SchemaOrgTypes.ItemListElement]: number[];
+}

package/dist/types/models/api/IAuditableItemGraphVersionGetRequest.d.ts

@@ -0,0 +1,25 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+/**
+ * Get an auditable item graph vertex at a specific version.
+ */
+export interface IAuditableItemGraphVersionGetRequest {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The parameters from the path.
+     */
+    pathParams: {
+        /**
+         * The id of the vertex.
+         */
+        id: string;
+        /**
+         * The id of the version (changeset id) to get.
+         */
+        versionId: string;
+    };
+}

package/dist/types/models/api/IAuditableItemGraphVersionGetResponse.d.ts

@@ -0,0 +1,17 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+import type { IAuditableItemGraphVertex } from "../IAuditableItemGraphVertex.js";
+/**
+ * Response to getting an auditable item graph vertex at a specific version.
+ */
+export interface IAuditableItemGraphVersionGetResponse {
+    /**
+     * The headers.
+     */
+    headers?: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The response body.
+     */
+    body: IAuditableItemGraphVertex;
+}

package/dist/types/models/api/IAuditableItemGraphVersionListRequest.d.ts

@@ -0,0 +1,34 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+/**
+ * Get all versions of an auditable item graph vertex.
+ */
+export interface IAuditableItemGraphVersionListRequest {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The parameters from the path.
+     */
+    pathParams: {
+        /**
+         * The id of the vertex.
+         */
+        id: string;
+    };
+    /**
+     * The query parameters.
+     */
+    query?: {
+        /**
+         * Only return versions created after this ISO 8601 timestamp (exclusive).
+         */
+        after?: string;
+        /**
+         * Only return versions created before this ISO 8601 timestamp (exclusive).
+         */
+        before?: string;
+    };
+}

package/dist/types/models/api/IAuditableItemGraphVersionListResponse.d.ts

@@ -0,0 +1,17 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+import type { IAuditableItemGraphVertexVersionList } from "../IAuditableItemGraphVertexVersionList.js";
+/**
+ * Response to getting all versions of an auditable item graph vertex.
+ */
+export interface IAuditableItemGraphVersionListResponse {
+    /**
+     * The headers.
+     */
+    headers?: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The response body.
+     */
+    body: IAuditableItemGraphVertexVersionList;
+}

package/dist/types/models/auditableItemGraphMetricIds.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Metric IDs for the auditable item graph service.
+ */
+export declare const AuditableItemGraphMetricIds: {
+    /**
+     * Number of vertices created.
+     */
+    readonly VerticesCreated: "aig_vertices_created";
+    /**
+     * Number of vertices updated.
+     */
+    readonly VerticesUpdated: "aig_vertices_updated";
+    /**
+     * Number of changesets created.
+     */
+    readonly ChangesetsCreated: "aig_changesets_created";
+    /**
+     * Number of aliases added.
+     */
+    readonly AliasesAdded: "aig_aliases_added";
+    /**
+     * Number of aliases modified.
+     */
+    readonly AliasesModified: "aig_aliases_modified";
+    /**
+     * Number of aliases deleted.
+     */
+    readonly AliasesDeleted: "aig_aliases_deleted";
+    /**
+     * Number of resources added.
+     */
+    readonly ResourcesAdded: "aig_resources_added";
+    /**
+     * Number of resources modified.
+     */
+    readonly ResourcesModified: "aig_resources_modified";
+    /**
+     * Number of resources deleted.
+     */
+    readonly ResourcesDeleted: "aig_resources_deleted";
+    /**
+     * Number of edges added.
+     */
+    readonly EdgesAdded: "aig_edges_added";
+    /**
+     * Number of edges modified.
+     */
+    readonly EdgesModified: "aig_edges_modified";
+    /**
+     * Number of edges deleted.
+     */
+    readonly EdgesDeleted: "aig_edges_deleted";
+    /**
+     * Number of queries executed.
+     */
+    readonly QueriesExecuted: "aig_queries_executed";
+    /**
+     * Number of verifications succeeded.
+     */
+    readonly VerificationsSucceeded: "aig_verifications_succeeded";
+    /**
+     * Number of verifications failed.
+     */
+    readonly VerificationsFailed: "aig_verifications_failed";
+};
+/**
+ * Metric IDs for the auditable item graph service.
+ */
+export type AuditableItemGraphMetricIds = (typeof AuditableItemGraphMetricIds)[keyof typeof AuditableItemGraphMetricIds];

package/dist/types/models/auditableItemGraphMetrics.d.ts

@@ -0,0 +1,5 @@
+import { type ITelemetryMetric } from "@twin.org/telemetry-models";
+/**
+ * Metrics registered by the auditable item graph service.
+ */
+export declare const AuditableItemGraphMetrics: ITelemetryMetric[];

package/dist/types/models/auditableItemGraphTypes.d.ts

@@ -34,6 +34,10 @@ export declare const AuditableItemGraphTypes: {
      * Represents patch operation.
      */
     readonly PatchOperation: "AuditableItemGraphPatchOperation";
+    /**
+     * Represents auditable item graph vertex version list.
+     */
+    readonly VertexVersionList: "AuditableItemGraphVertexVersionList";
 };
 /**
  * The types of auditable item graph data.

package/docs/changelog.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.0.3-next.15](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.14...auditable-item-graph-models-v0.0.3-next.15) (2026-05-20)
+
+
+### Features
+
+* add event-driven telemetry metrics ([#63](https://github.com/iotaledger/twin-auditable-item-graph/issues/63)) ([8fe6cdd](https://github.com/iotaledger/twin-auditable-item-graph/commit/8fe6cdd0d56496402b766c151f002f475ddb8c0e))
+
+## [0.0.3-next.14](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.13...auditable-item-graph-models-v0.0.3-next.14) (2026-05-18)
+
+
+### Features
+
+* add versions ([#60](https://github.com/iotaledger/twin-auditable-item-graph/issues/60)) ([5c36f94](https://github.com/iotaledger/twin-auditable-item-graph/commit/5c36f94b1155c01dddbc8d62f3f65d599916c521))
+
 ## [0.0.3-next.13](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.12...auditable-item-graph-models-v0.0.3-next.13) (2026-05-12)
 
 

package/docs/reference/index.md

@@ -16,6 +16,7 @@
 - [IAuditableItemGraphResource](interfaces/IAuditableItemGraphResource.md)
 - [IAuditableItemGraphVertex](interfaces/IAuditableItemGraphVertex.md)
 - [IAuditableItemGraphVertexList](interfaces/IAuditableItemGraphVertexList.md)
+- [IAuditableItemGraphVertexVersionList](interfaces/IAuditableItemGraphVertexVersionList.md)
 - [IAuditableItemGraphChangesetGetRequest](interfaces/IAuditableItemGraphChangesetGetRequest.md)
 - [IAuditableItemGraphChangesetGetResponse](interfaces/IAuditableItemGraphChangesetGetResponse.md)
 - [IAuditableItemGraphChangesetListRequest](interfaces/IAuditableItemGraphChangesetListRequest.md)
@@ -26,12 +27,17 @@
 - [IAuditableItemGraphListRequest](interfaces/IAuditableItemGraphListRequest.md)
 - [IAuditableItemGraphListResponse](interfaces/IAuditableItemGraphListResponse.md)
 - [IAuditableItemGraphUpdateRequest](interfaces/IAuditableItemGraphUpdateRequest.md)
+- [IAuditableItemGraphVersionGetRequest](interfaces/IAuditableItemGraphVersionGetRequest.md)
+- [IAuditableItemGraphVersionGetResponse](interfaces/IAuditableItemGraphVersionGetResponse.md)
+- [IAuditableItemGraphVersionListRequest](interfaces/IAuditableItemGraphVersionListRequest.md)
+- [IAuditableItemGraphVersionListResponse](interfaces/IAuditableItemGraphVersionListResponse.md)
 - [IAuditableItemGraphEventBusVertexCreated](interfaces/IAuditableItemGraphEventBusVertexCreated.md)
 - [IAuditableItemGraphEventBusVertexUpdated](interfaces/IAuditableItemGraphEventBusVertexUpdated.md)
 
 ## Type Aliases
 
 - [AuditableItemGraphContexts](type-aliases/AuditableItemGraphContexts.md)
+- [AuditableItemGraphMetricIds](type-aliases/AuditableItemGraphMetricIds.md)
 - [AuditableItemGraphTopics](type-aliases/AuditableItemGraphTopics.md)
 - [AuditableItemGraphTypes](type-aliases/AuditableItemGraphTypes.md)
 - [VerifyDepth](type-aliases/VerifyDepth.md)
@@ -39,6 +45,8 @@
 ## Variables
 
 - [AuditableItemGraphContexts](variables/AuditableItemGraphContexts.md)
+- [AuditableItemGraphMetricIds](variables/AuditableItemGraphMetricIds.md)
+- [AuditableItemGraphMetrics](variables/AuditableItemGraphMetrics.md)
 - [AuditableItemGraphTopics](variables/AuditableItemGraphTopics.md)
 - [AuditableItemGraphTypes](variables/AuditableItemGraphTypes.md)
 - [VerifyDepth](variables/VerifyDepth.md)

package/docs/reference/interfaces/IAuditableItemGraphChangeset.md

@@ -65,3 +65,12 @@ The immutable proof id which contains the signature for this changeset.
 > `optional` **verification?**: `IImmutableProofVerification`
 
 The verification for the changeset.
+
+***
+
+### version? {#version}
+
+> `optional` **version?**: `number`
+
+The version number of the vertex after this changeset was applied.
+Maps to https://schema.org/version.

package/docs/reference/interfaces/IAuditableItemGraphComponent.md

@@ -178,6 +178,80 @@ NotFoundError if the vertex or changeset is not found.
 
 ***
 
+### getVersion() {#getversion}
+
+> **getVersion**(`id`, `versionId`): `Promise`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)\>
+
+Get a graph vertex at a specific version.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the vertex.
+
+##### versionId
+
+`string`
+
+The id of the version (changeset id) to retrieve.
+
+#### Returns
+
+`Promise`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)\>
+
+The vertex reconstructed at that version.
+
+#### Throws
+
+NotFoundError if the vertex or version is not found.
+
+***
+
+### getVersions() {#getversions}
+
+> **getVersions**(`id`, `options?`): `Promise`\<[`IAuditableItemGraphVertexVersionList`](IAuditableItemGraphVertexVersionList.md)\>
+
+Get all versions of a graph vertex.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The id of the vertex.
+
+##### options?
+
+Additional options for the operation.
+
+###### after?
+
+`string`
+
+Only return versions created after this ISO 8601 timestamp (exclusive).
+
+###### before?
+
+`string`
+
+Only return versions created before this ISO 8601 timestamp (exclusive).
+
+#### Returns
+
+`Promise`\<[`IAuditableItemGraphVertexVersionList`](IAuditableItemGraphVertexVersionList.md)\>
+
+The list of vertex versions.
+
+#### Throws
+
+NotFoundError if the vertex is not found.
+
+***
+
 ### removeVerifiable() {#removeverifiable}
 
 > **removeVerifiable**(`id`): `Promise`\<`void`\>

package/docs/reference/interfaces/IAuditableItemGraphVersionGetRequest.md

@@ -0,0 +1,35 @@
+# Interface: IAuditableItemGraphVersionGetRequest
+
+Get an auditable item graph vertex at a specific version.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept
+
+> **accept**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The parameters from the path.
+
+#### id
+
+> **id**: `string`
+
+The id of the vertex.
+
+#### versionId
+
+> **versionId**: `string`
+
+The id of the version (changeset id) to get.

package/docs/reference/interfaces/IAuditableItemGraphVersionGetResponse.md

@@ -0,0 +1,23 @@
+# Interface: IAuditableItemGraphVersionGetResponse
+
+Response to getting an auditable item graph vertex at a specific version.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The headers.
+
+#### content-type
+
+> **content-type**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### body {#body}
+
+> **body**: [`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)
+
+The response body.

package/docs/reference/interfaces/IAuditableItemGraphVersionListRequest.md

@@ -0,0 +1,49 @@
+# Interface: IAuditableItemGraphVersionListRequest
+
+Get all versions of an auditable item graph vertex.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept
+
+> **accept**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The parameters from the path.
+
+#### id
+
+> **id**: `string`
+
+The id of the vertex.
+
+***
+
+### query? {#query}
+
+> `optional` **query?**: `object`
+
+The query parameters.
+
+#### after?
+
+> `optional` **after?**: `string`
+
+Only return versions created after this ISO 8601 timestamp (exclusive).
+
+#### before?
+
+> `optional` **before?**: `string`
+
+Only return versions created before this ISO 8601 timestamp (exclusive).

package/docs/reference/interfaces/IAuditableItemGraphVersionListResponse.md

@@ -0,0 +1,23 @@
+# Interface: IAuditableItemGraphVersionListResponse
+
+Response to getting all versions of an auditable item graph vertex.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The headers.
+
+#### content-type
+
+> **content-type**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### body {#body}
+
+> **body**: [`IAuditableItemGraphVertexVersionList`](IAuditableItemGraphVertexVersionList.md)
+
+The response body.

package/docs/reference/interfaces/IAuditableItemGraphVertex.md

@@ -117,3 +117,12 @@ Edges connected to the vertex.
 > `optional` **verified?**: `boolean`
 
 Is the vertex verified, will only be populated when verification is requested.
+
+***
+
+### version? {#version}
+
+> `optional` **version?**: `number`
+
+The version of the vertex, populated only when getting a specific version.
+Maps to https://schema.org/version.

package/docs/reference/interfaces/IAuditableItemGraphVertexVersionList.md

@@ -0,0 +1,27 @@
+# Interface: IAuditableItemGraphVertexVersionList
+
+Interface describing a list of auditable item graph vertex version numbers.
+
+## Properties
+
+### @context {#context}
+
+> **@context**: \[`"https://schema.org"`, `"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
+
+JSON-LD Context.
+
+***
+
+### type {#type}
+
+> **type**: \[`"ItemList"`, `"AuditableItemGraphVertexVersionList"`\]
+
+JSON-LD Type.
+
+***
+
+### itemListElement {#itemlistelement}
+
+> **itemListElement**: `number`[]
+
+The list of version numbers.

package/docs/reference/type-aliases/AuditableItemGraphMetricIds.md

@@ -0,0 +1,5 @@
+# Type Alias: AuditableItemGraphMetricIds
+
+> **AuditableItemGraphMetricIds** = *typeof* [`AuditableItemGraphMetricIds`](../variables/AuditableItemGraphMetricIds.md)\[keyof *typeof* [`AuditableItemGraphMetricIds`](../variables/AuditableItemGraphMetricIds.md)\]
+
+Metric IDs for the auditable item graph service.

package/docs/reference/variables/AuditableItemGraphMetricIds.md

@@ -0,0 +1,97 @@
+# Variable: AuditableItemGraphMetricIds
+
+> `const` **AuditableItemGraphMetricIds**: `object`
+
+Metric IDs for the auditable item graph service.
+
+## Type Declaration
+
+### VerticesCreated {#verticescreated}
+
+> `readonly` **VerticesCreated**: `"aig_vertices_created"` = `"aig_vertices_created"`
+
+Number of vertices created.
+
+### VerticesUpdated {#verticesupdated}
+
+> `readonly` **VerticesUpdated**: `"aig_vertices_updated"` = `"aig_vertices_updated"`
+
+Number of vertices updated.
+
+### ChangesetsCreated {#changesetscreated}
+
+> `readonly` **ChangesetsCreated**: `"aig_changesets_created"` = `"aig_changesets_created"`
+
+Number of changesets created.
+
+### AliasesAdded {#aliasesadded}
+
+> `readonly` **AliasesAdded**: `"aig_aliases_added"` = `"aig_aliases_added"`
+
+Number of aliases added.
+
+### AliasesModified {#aliasesmodified}
+
+> `readonly` **AliasesModified**: `"aig_aliases_modified"` = `"aig_aliases_modified"`
+
+Number of aliases modified.
+
+### AliasesDeleted {#aliasesdeleted}
+
+> `readonly` **AliasesDeleted**: `"aig_aliases_deleted"` = `"aig_aliases_deleted"`
+
+Number of aliases deleted.
+
+### ResourcesAdded {#resourcesadded}
+
+> `readonly` **ResourcesAdded**: `"aig_resources_added"` = `"aig_resources_added"`
+
+Number of resources added.
+
+### ResourcesModified {#resourcesmodified}
+
+> `readonly` **ResourcesModified**: `"aig_resources_modified"` = `"aig_resources_modified"`
+
+Number of resources modified.
+
+### ResourcesDeleted {#resourcesdeleted}
+
+> `readonly` **ResourcesDeleted**: `"aig_resources_deleted"` = `"aig_resources_deleted"`
+
+Number of resources deleted.
+
+### EdgesAdded {#edgesadded}
+
+> `readonly` **EdgesAdded**: `"aig_edges_added"` = `"aig_edges_added"`
+
+Number of edges added.
+
+### EdgesModified {#edgesmodified}
+
+> `readonly` **EdgesModified**: `"aig_edges_modified"` = `"aig_edges_modified"`
+
+Number of edges modified.
+
+### EdgesDeleted {#edgesdeleted}
+
+> `readonly` **EdgesDeleted**: `"aig_edges_deleted"` = `"aig_edges_deleted"`
+
+Number of edges deleted.
+
+### QueriesExecuted {#queriesexecuted}
+
+> `readonly` **QueriesExecuted**: `"aig_queries_executed"` = `"aig_queries_executed"`
+
+Number of queries executed.
+
+### VerificationsSucceeded {#verificationssucceeded}
+
+> `readonly` **VerificationsSucceeded**: `"aig_verifications_succeeded"` = `"aig_verifications_succeeded"`
+
+Number of verifications succeeded.
+
+### VerificationsFailed {#verificationsfailed}
+
+> `readonly` **VerificationsFailed**: `"aig_verifications_failed"` = `"aig_verifications_failed"`
+
+Number of verifications failed.

package/docs/reference/variables/AuditableItemGraphMetrics.md

@@ -0,0 +1,5 @@
+# Variable: AuditableItemGraphMetrics
+
+> `const` **AuditableItemGraphMetrics**: `ITelemetryMetric`[]
+
+Metrics registered by the auditable item graph service.

package/docs/reference/variables/AuditableItemGraphTypes.md

@@ -53,3 +53,9 @@ Represents auditable item graph changeset list.
 > `readonly` **PatchOperation**: `"AuditableItemGraphPatchOperation"` = `"AuditableItemGraphPatchOperation"`
 
 Represents patch operation.
+
+### VertexVersionList {#vertexversionlist}
+
+> `readonly` **VertexVersionList**: `"AuditableItemGraphVertexVersionList"` = `"AuditableItemGraphVertexVersionList"`
+
+Represents auditable item graph vertex version list.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/auditable-item-graph-models",
-	"version": "0.0.3-next.13",
+	"version": "0.0.3-next.15",
 	"description": "Defines shared graph data contracts, JSON schemas, and JSON-LD contexts for consistent interoperability.",
 	"repository": {
 		"type": "git",
@@ -21,6 +21,7 @@
 		"@twin.org/immutable-proof-models": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-schema-org": "next",
+		"@twin.org/telemetry-models": "next",
 		"@twin.org/web": "next"
 	},
 	"main": "./dist/es/index.js",