@twin.org/auditable-item-graph-models 0.0.3-next.14 → 0.0.3-next.16

package/dist/es/index.js

@@ -16,6 +16,8 @@ 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";

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,sDAAsD,CAAC;AACrE,cAAc,uDAAuD,CAAC;AACtE,cAAc,uDAAuD,CAAC;AACtE,cAAc,wDAAwD,CAAC;AACvE,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,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/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"]}
+{"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/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 { 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"]}
+{"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 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 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/IAuditableItemGraphVertexVersionList.js.map

@@ -1 +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"]}
+{"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 versions.\n\t * @json-ld namespace:sch\n\t */\n\t[SchemaOrgTypes.ItemListElement]: { version: number; dateCreated: string }[];\n}\n"]}

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

@@ -1 +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"]}
+{"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 version number to get.\n\t\t */\n\t\tversion: string;\n\t};\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/types/index.d.ts

@@ -14,6 +14,8 @@ 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";

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

@@ -74,11 +74,11 @@ export interface IAuditableItemGraphComponent extends IComponent {
     /**
      * 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.
+     * @param version The version number 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>;
+    getVersion(id: string, version: number): Promise<IAuditableItemGraphVertex>;
     /**
      * Get all versions of a graph vertex.
      * @param id The id of the vertex.

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

@@ -19,8 +19,11 @@ export interface IAuditableItemGraphVertexVersionList {
      */
     type: [typeof SchemaOrgTypes.ItemList, typeof AuditableItemGraphTypes.VertexVersionList];
     /**
-     * The list of version numbers.
+     * The list of versions.
      * @json-ld namespace:sch
      */
-    [SchemaOrgTypes.ItemListElement]: number[];
+    [SchemaOrgTypes.ItemListElement]: {
+        version: number;
+        dateCreated: string;
+    }[];
 }

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

@@ -18,8 +18,8 @@ export interface IAuditableItemGraphVersionGetRequest {
          */
         id: string;
         /**
-         * The id of the version (changeset id) to get.
+         * The version number to get.
          */
-        versionId: string;
+        version: string;
     };
 }

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/docs/changelog.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.0.3-next.16](https://github.com/iotaledger/twin-auditable-item-graph/compare/auditable-item-graph-models-v0.0.3-next.15...auditable-item-graph-models-v0.0.3-next.16) (2026-05-22)
+
+
+### Features
+
+* improved versioning ([#66](https://github.com/iotaledger/twin-auditable-item-graph/issues/66)) ([1b497cd](https://github.com/iotaledger/twin-auditable-item-graph/commit/1b497cdc88eec9b6707b097283773e109baae3aa))
+
+## [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)
 
 

package/docs/reference/index.md

@@ -37,6 +37,7 @@
 ## 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)
@@ -44,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/IAuditableItemGraphComponent.md

@@ -180,7 +180,7 @@ NotFoundError if the vertex or changeset is not found.
 
 ### getVersion() {#getversion}
 
-> **getVersion**(`id`, `versionId`): `Promise`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)\>
+> **getVersion**(`id`, `version`): `Promise`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)\>
 
 Get a graph vertex at a specific version.
 
@@ -192,11 +192,11 @@ Get a graph vertex at a specific version.
 
 The id of the vertex.
 
-##### versionId
+##### version
 
-`string`
+`number`
 
-The id of the version (changeset id) to retrieve.
+The version number to retrieve.
 
 #### Returns
 

package/docs/reference/interfaces/IAuditableItemGraphVersionGetRequest.md

@@ -28,8 +28,8 @@ The parameters from the path.
 
 The id of the vertex.
 
-#### versionId
+#### version
 
-> **versionId**: `string`
+> **version**: `string`
 
-The id of the version (changeset id) to get.
+The version number to get.

package/docs/reference/interfaces/IAuditableItemGraphVertexVersionList.md

@@ -22,6 +22,14 @@ JSON-LD Type.
 
 ### itemListElement {#itemlistelement}
 
-> **itemListElement**: `number`[]
+> **itemListElement**: `object`[]
 
-The list of version numbers.
+The list of versions.
+
+#### version
+
+> **version**: `number`
+
+#### dateCreated
+
+> **dateCreated**: `string`

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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/auditable-item-graph-models",
-	"version": "0.0.3-next.14",
+	"version": "0.0.3-next.16",
 	"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",