@twin.org/auditable-item-graph-service 0.0.3-next.8 → 0.9.0-next.2

package/docs/reference/classes/AuditableItemGraphVertex.md

@@ -14,7 +14,7 @@ Class describing the auditable item graph vertex.
 
 ## Properties
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -22,15 +22,15 @@ The id of the vertex.
 
 ***
 
-### organizationIdentity?
+### organizationIdentity {#organizationidentity}
 
-> `optional` **organizationIdentity**: `string`
+> **organizationIdentity**: `string`
 
 The identity of the organization which controls the vertex.
 
 ***
 
-### dateCreated
+### dateCreated {#datecreated}
 
 > **dateCreated**: `string`
 
@@ -38,56 +38,64 @@ The date/time of when the vertex was created.
 
 ***
 
-### dateModified?
+### dateModified? {#datemodified}
 
-> `optional` **dateModified**: `string`
+> `optional` **dateModified?**: `string`
 
 The date/time of when the vertex was last modified.
 
 ***
 
-### aliasIndex?
+### aliasIndex? {#aliasindex}
 
-> `optional` **aliasIndex**: `string`
+> `optional` **aliasIndex?**: `string`
 
 Combined alias index for the vertex used for querying.
 
 ***
 
-### resourceTypeIndex?
+### resourceTypeIndex? {#resourcetypeindex}
 
-> `optional` **resourceTypeIndex**: `string`
+> `optional` **resourceTypeIndex?**: `string`
 
 Combined resource type index for the vertex used for querying.
 
 ***
 
-### annotationObject?
+### annotationObject? {#annotationobject}
 
-> `optional` **annotationObject**: `IJsonLdNodeObject`
+> `optional` **annotationObject?**: `IJsonLdNodeObject`
 
 Object to associate with the vertex as JSON-LD.
 
 ***
 
-### aliases?
+### aliases? {#aliases}
 
-> `optional` **aliases**: [`AuditableItemGraphAlias`](AuditableItemGraphAlias.md)[]
+> `optional` **aliases?**: [`AuditableItemGraphAlias`](AuditableItemGraphAlias.md)[]
 
 Alternative aliases that can be used to identify the vertex.
 
 ***
 
-### resources?
+### resources? {#resources}
 
-> `optional` **resources**: [`AuditableItemGraphResource`](AuditableItemGraphResource.md)[]
+> `optional` **resources?**: [`AuditableItemGraphResource`](AuditableItemGraphResource.md)[]
 
 The resources attached to the vertex.
 
 ***
 
-### edges?
+### edges? {#edges}
 
-> `optional` **edges**: [`AuditableItemGraphEdge`](AuditableItemGraphEdge.md)[]
+> `optional` **edges?**: [`AuditableItemGraphEdge`](AuditableItemGraphEdge.md)[]
 
 Edges connected to the vertex.
+
+***
+
+### version? {#version}
+
+> `optional` **version?**: `number`
+
+The current version of the vertex, incremented on each changeset.

package/docs/reference/functions/auditableItemGraphRemoveProof.md

@@ -0,0 +1,31 @@
+# Function: auditableItemGraphRemoveProof()
+
+> **auditableItemGraphRemoveProof**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Remove the notarization proof from all changesets of a graph vertex.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IAuditableItemGraphRemoveProofRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/auditableItemGraphUpdate.md

@@ -2,7 +2,7 @@
 
 > **auditableItemGraphUpdate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
 
-Update the graph vertex.
+Update the graph vertex (PUT — full replacement of vertex state).
 
 ## Parameters
 

package/docs/reference/functions/auditableItemGraphUpdatePartial.md

@@ -0,0 +1,31 @@
+# Function: auditableItemGraphUpdatePartial()
+
+> **auditableItemGraphUpdatePartial**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
+
+Partially update the graph vertex (PATCH — optional scalars; list fields use `{ add, remove }`).
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IAuditableItemGraphUpdatePartialRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`INoContentResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/auditableItemGraphVersionGet.md

@@ -0,0 +1,31 @@
+# Function: auditableItemGraphVersionGet()
+
+> **auditableItemGraphVersionGet**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IAuditableItemGraphVersionGetResponse`\>
+
+Get the graph vertex at a specific version.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IAuditableItemGraphVersionGetRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IAuditableItemGraphVersionGetResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/auditableItemGraphVersionList.md

@@ -0,0 +1,31 @@
+# Function: auditableItemGraphVersionList()
+
+> **auditableItemGraphVersionList**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IAuditableItemGraphVersionListResponse`\>
+
+Get all versions of a graph vertex.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IAuditableItemGraphVersionListRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IAuditableItemGraphVersionListResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/index.md

@@ -28,5 +28,9 @@
 - [auditableItemGraphChangesetList](functions/auditableItemGraphChangesetList.md)
 - [auditableItemGraphChangesetGet](functions/auditableItemGraphChangesetGet.md)
 - [auditableItemGraphUpdate](functions/auditableItemGraphUpdate.md)
+- [auditableItemGraphUpdatePartial](functions/auditableItemGraphUpdatePartial.md)
 - [auditableItemGraphList](functions/auditableItemGraphList.md)
+- [auditableItemGraphVersionGet](functions/auditableItemGraphVersionGet.md)
+- [auditableItemGraphRemoveProof](functions/auditableItemGraphRemoveProof.md)
+- [auditableItemGraphVersionList](functions/auditableItemGraphVersionList.md)
 - [initSchema](functions/initSchema.md)

package/docs/reference/interfaces/IAuditableItemGraphServiceConfig.md

@@ -1,3 +1,11 @@
 # Interface: IAuditableItemGraphServiceConfig
 
 Configuration for the auditable item graph service.
+
+## Properties
+
+### mutexTimeoutMs? {#mutextimeoutms}
+
+> `optional` **mutexTimeoutMs?**: `number`
+
+Timeout in milliseconds for acquiring a mutex lock.

package/docs/reference/interfaces/IAuditableItemGraphServiceConstructorOptions.md

@@ -4,9 +4,9 @@ Options for the constructor of the auditable item graph service.
 
 ## Properties
 
-### immutableProofComponentType?
+### immutableProofComponentType? {#immutableproofcomponenttype}
 
-> `optional` **immutableProofComponentType**: `string`
+> `optional` **immutableProofComponentType?**: `string`
 
 The immutable proof component type.
 
@@ -18,9 +18,9 @@ immutable-proof
 
 ***
 
-### vertexEntityStorageType?
+### vertexEntityStorageType? {#vertexentitystoragetype}
 
-> `optional` **vertexEntityStorageType**: `string`
+> `optional` **vertexEntityStorageType?**: `string`
 
 The entity storage for vertices.
 
@@ -32,9 +32,9 @@ auditable-item-graph-vertex
 
 ***
 
-### changesetEntityStorageType?
+### changesetEntityStorageType? {#changesetentitystoragetype}
 
-> `optional` **changesetEntityStorageType**: `string`
+> `optional` **changesetEntityStorageType?**: `string`
 
 The entity storage for changesets.
 
@@ -46,16 +46,24 @@ auditable-item-graph-changeset
 
 ***
 
-### eventBusComponentType?
+### eventBusComponentType? {#eventbuscomponenttype}
 
-> `optional` **eventBusComponentType**: `string`
+> `optional` **eventBusComponentType?**: `string`
 
 The event bus component type, defaults to no event bus.
 
 ***
 
-### config?
+### telemetryComponentType? {#telemetrycomponenttype}
 
-> `optional` **config**: [`IAuditableItemGraphServiceConfig`](IAuditableItemGraphServiceConfig.md)
+> `optional` **telemetryComponentType?**: `string`
+
+The component type for the optional telemetry component used for event metrics, defaults to no telemetry.
+
+***
+
+### config? {#config}
+
+> `optional` **config?**: [`IAuditableItemGraphServiceConfig`](IAuditableItemGraphServiceConfig.md)
 
 The configuration for the service.

package/docs/reference/variables/restEntryPoints.md

@@ -1,3 +1,5 @@
 # Variable: restEntryPoints
 
 > `const` **restEntryPoints**: `IRestRouteEntryPoint`[]
+
+The REST entry points for the auditable item graph service.

package/locales/en.json

@@ -4,14 +4,18 @@
 			"namespaceMismatch": "The namespace in the urn \"{id}\" does not match the namespace of the Auditable Item Graph service \"{namespace}\"",
 			"createFailed": "Creating the Auditable Item Graph vertex failed",
 			"getFailed": "Getting the Auditable Item Graph vertex failed",
+			"getVersionFailed": "Getting the Auditable Item Graph vertex version failed",
+			"getVersionsFailed": "Getting the Auditable Item Graph vertex versions failed",
+			"versionNotFound": "The version with the Id \"{notFoundId}\" was not found",
 			"updatingFailed": "Updating the Auditable Item Graph vertex failed",
 			"queryingFailed": "Querying the Auditable Item Graph failed",
-			"removeVerifiableFailed": "Removing the verifiable data the Auditable Item Graph vertex failed",
+			"removeProofFailed": "Removing the proof from the Auditable Item Graph vertex failed",
 			"vertexNotFound": "The vertex with the Id \"{notFoundId}\" was not found",
 			"changesetNotFound": "The changeset with the Id \"{notFoundId}\" was not found",
 			"resourceIdMissing": "You must provide either the id, or the resourceObject must contain an id property for index \"{index}\"",
 			"aliasNotUnique": "The alias id \"{aliasId}\" is already in use on another vertex and the unique flag was set",
-			"invalidEdgeId": "The edge id \"{edgeId}\" is not valid"
+			"invalidEdgeId": "The edge id \"{edgeId}\" is not valid",
+			"listPatchInvalidFormat": "The property \"{property}\" must be a list patch object with add and/or remove, not a bare array"
 		},
 		"validation": {
 			"auditableItemGraphService": {

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/auditable-item-graph-service",
-	"version": "0.0.3-next.8",
-	"description": "Auditable Item Graph contract implementation and REST endpoint definitions",
+	"version": "0.9.0-next.2",
+	"description": "Implements graph lifecycle operations and audited change tracking with API route definitions.",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/auditable-item-graph.git",
+		"url": "git+https://github.com/iotaledger/twin-auditable-item-graph.git",
 		"directory": "packages/auditable-item-graph-service"
 	},
 	"author": "martyn.janes@iota.org",
@@ -15,7 +15,7 @@
 	},
 	"dependencies": {
 		"@twin.org/api-models": "next",
-		"@twin.org/auditable-item-graph-models": "0.0.3-next.8",
+		"@twin.org/auditable-item-graph-models": "0.9.0-next.2",
 		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
@@ -27,7 +27,7 @@
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-schema-org": "next",
 		"@twin.org/standards-w3c-did": "next",
-		"@twin.org/verifiable-storage-models": "next",
+		"@twin.org/telemetry-models": "next",
 		"@twin.org/web": "next"
 	},
 	"main": "./dist/es/index.js",
@@ -58,7 +58,7 @@
 		"business-logic"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/auditable-item-graph/issues"
+		"url": "git+https://github.com/iotaledger/twin-auditable-item-graph/issues"
 	},
 	"homepage": "https://twindev.org"
 }