@twin.org/auditable-item-graph-models 0.0.3-next.9 → 0.9.0-next.1

package/docs/reference/interfaces/IAuditableItemGraphUpdateRequest.md

@@ -1,10 +1,10 @@
 # Interface: IAuditableItemGraphUpdateRequest
 
-Update an auditable item graph vertex.
+Update an auditable item graph vertex (PUT — full replacement of vertex state).
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -18,32 +18,8 @@ The id of the vertex to update.
 
 ***
 
-### body
+### body {#body}
 
-> **body**: `object`
+> **body**: `Omit`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md), `"id"`\>
 
-The data to be used in the vertex.
-
-#### annotationObject?
-
-> `optional` **annotationObject**: `IJsonLdNodeObject`
-
-The object to be used in the vertex as JSON-LD.
-
-#### aliases?
-
-> `optional` **aliases**: `object`[]
-
-Alternative aliases that can be used to identify the vertex.
-
-#### resources?
-
-> `optional` **resources**: `object`[]
-
-The resources attached to the vertex.
-
-#### edges?
-
-> `optional` **edges**: `object`[]
-
-The edges connected to the vertex.
+The full vertex payload. Replaces annotation and active sub-lists; omitted collections are cleared.

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.
+
+#### version
+
+> **version**: `string`
+
+The version number 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

@@ -8,12 +8,11 @@ Interface describing an auditable item graph vertex.
 
 ## Properties
 
-### dateCreated?
+### dateCreated? {#datecreated}
 
-> `optional` **dateCreated**: `string`
+> `optional` **dateCreated?**: `string`
 
 The date/time of when the element was created.
-json-ld namespace:schema
 
 #### Inherited from
 
@@ -21,12 +20,11 @@ json-ld namespace:schema
 
 ***
 
-### dateModified?
+### dateModified? {#datemodified}
 
-> `optional` **dateModified**: `string`
+> `optional` **dateModified?**: `string`
 
 The date/time of when the element was modified.
-json-ld namespace:schema
 
 #### Inherited from
 
@@ -34,12 +32,11 @@ json-ld namespace:schema
 
 ***
 
-### dateDeleted?
+### dateDeleted? {#datedeleted}
 
-> `optional` **dateDeleted**: `string`
+> `optional` **dateDeleted?**: `string`
 
 The date/time of when the element was deleted, as we never actually remove items.
-json-ld namespace:schema
 
 #### Inherited from
 
@@ -47,7 +44,7 @@ json-ld namespace:schema
 
 ***
 
-### @context
+### @context {#context}
 
 > **@context**: \[`"https://schema.twindev.org/aig/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
 
@@ -55,7 +52,7 @@ JSON-LD Context.
 
 ***
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -67,7 +64,7 @@ The id of the element.
 
 ***
 
-### type
+### type {#type}
 
 > **type**: `"AuditableItemGraphVertex"`
 
@@ -75,54 +72,57 @@ JSON-LD Type.
 
 ***
 
-### organizationIdentity?
+### organizationIdentity? {#organizationidentity}
 
-> `optional` **organizationIdentity**: `string`
+> `optional` **organizationIdentity?**: `string`
 
 The identity of the organization which controls the vertex.
-json-ld namespace:twin-common
 
 ***
 
-### annotationObject?
+### annotationObject? {#annotationobject}
 
-> `optional` **annotationObject**: `IJsonLdNodeObject`
+> `optional` **annotationObject?**: `IJsonLdNodeObject`
 
 The JSON-LD annotation object for the vertex.
-json-ld namespace:twin-common
 
 ***
 
-### aliases?
+### aliases? {#aliases}
 
-> `optional` **aliases**: [`IAuditableItemGraphAlias`](IAuditableItemGraphAlias.md)[]
+> `optional` **aliases?**: [`IAuditableItemGraphAlias`](IAuditableItemGraphAlias.md)[]
 
 Alternative aliases that can be used to identify the vertex.
-json-ld container:set
 
 ***
 
-### resources?
+### resources? {#resources}
 
-> `optional` **resources**: [`IAuditableItemGraphResource`](IAuditableItemGraphResource.md)[]
+> `optional` **resources?**: [`IAuditableItemGraphResource`](IAuditableItemGraphResource.md)[]
 
 The resources attached to the vertex.
-json-ld container:set
 
 ***
 
-### edges?
+### edges? {#edges}
 
-> `optional` **edges**: [`IAuditableItemGraphEdge`](IAuditableItemGraphEdge.md)[]
+> `optional` **edges?**: [`IAuditableItemGraphEdge`](IAuditableItemGraphEdge.md)[]
 
 Edges connected to the vertex.
-json-ld container:set
 
 ***
 
-### verified?
+### verified? {#verified}
 
-> `optional` **verified**: `boolean`
+> `optional` **verified?**: `boolean`
 
 Is the vertex verified, will only be populated when verification is requested.
-json-ld namespace:twin-common
+
+***
+
+### 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/IAuditableItemGraphVertexList.md

@@ -4,7 +4,7 @@ Interface describing an auditable item graph vertex list.
 
 ## Properties
 
-### @context
+### @context {#context}
 
 > **@context**: \[`"https://schema.org"`, `"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
 
@@ -12,7 +12,7 @@ JSON-LD Context.
 
 ***
 
-### type
+### type {#type}
 
 > **type**: \[`"ItemList"`, `"AuditableItemGraphVertexList"`\]
 
@@ -20,9 +20,8 @@ JSON-LD Type.
 
 ***
 
-### itemListElement
+### itemListElement {#itemlistelement}
 
 > **itemListElement**: [`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)[]
 
 The list of vertices.
-json-ld namespace:schema

package/docs/reference/interfaces/IAuditableItemGraphVertexVersionList.md

@@ -0,0 +1,35 @@
+# 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**: `object`[]
+
+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/AuditableItemGraphContexts.md

@@ -6,37 +6,37 @@ The contexts of auditable item graph data.
 
 ## Type Declaration
 
-### Namespace
+### Namespace {#namespace}
 
 > `readonly` **Namespace**: `"https://schema.twindev.org/aig/"` = `"https://schema.twindev.org/aig/"`
 
 The canonical RDF namespace URI for Auditable Item Graph.
 
-### Context
+### Context {#context}
 
 > `readonly` **Context**: `"https://schema.twindev.org/aig/"` = `"https://schema.twindev.org/aig/"`
 
 The value to use in context for Auditable Item Graph.
 
-### JsonLdContext
+### JsonLdContext {#jsonldcontext}
 
 > `readonly` **JsonLdContext**: `"https://schema.twindev.org/aig/types.jsonld"` = `"https://schema.twindev.org/aig/types.jsonld"`
 
 The JSON-LD Context URL for Auditable Item Graph.
 
-### NamespaceCommon
+### NamespaceCommon {#namespacecommon}
 
 > `readonly` **NamespaceCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
 
 The canonical RDF namespace URI for TWIN Common.
 
-### ContextCommon
+### ContextCommon {#contextcommon}
 
 > `readonly` **ContextCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
 
 The value to use in JSON-LD context for TWIN Common.
 
-### JsonLdContextCommon
+### JsonLdContextCommon {#jsonldcontextcommon}
 
 > `readonly` **JsonLdContextCommon**: `"https://schema.twindev.org/common/types.jsonld"` = `"https://schema.twindev.org/common/types.jsonld"`
 

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/AuditableItemGraphTopics.md

@@ -6,13 +6,13 @@ The topics for auditable item graph event bus notifications.
 
 ## Type Declaration
 
-### VertexCreated
+### VertexCreated {#vertexcreated}
 
 > `readonly` **VertexCreated**: `"auditable-item-graph:vertex-created"` = `"auditable-item-graph:vertex-created"`
 
 A vertex was created.
 
-### VertexUpdated
+### VertexUpdated {#vertexupdated}
 
 > `readonly` **VertexUpdated**: `"auditable-item-graph:vertex-updated"` = `"auditable-item-graph:vertex-updated"`
 

package/docs/reference/variables/AuditableItemGraphTypes.md

@@ -6,50 +6,68 @@ The types of auditable item graph data.
 
 ## Type Declaration
 
-### Vertex
+### Vertex {#vertex}
 
 > `readonly` **Vertex**: `"AuditableItemGraphVertex"` = `"AuditableItemGraphVertex"`
 
 Represents auditable item graph vertex.
 
-### VertexList
+### VertexList {#vertexlist}
 
 > `readonly` **VertexList**: `"AuditableItemGraphVertexList"` = `"AuditableItemGraphVertexList"`
 
 Represents auditable item graph vertex list.
 
-### Alias
+### Alias {#alias}
 
 > `readonly` **Alias**: `"AuditableItemGraphAlias"` = `"AuditableItemGraphAlias"`
 
 Represents auditable item graph alias.
 
-### Resource
+### Resource {#resource}
 
 > `readonly` **Resource**: `"AuditableItemGraphResource"` = `"AuditableItemGraphResource"`
 
 Represents auditable item graph resource.
 
-### Edge
+### Edge {#edge}
 
 > `readonly` **Edge**: `"AuditableItemGraphEdge"` = `"AuditableItemGraphEdge"`
 
 Represents auditable item graph edge.
 
-### Changeset
+### Changeset {#changeset}
 
 > `readonly` **Changeset**: `"AuditableItemGraphChangeset"` = `"AuditableItemGraphChangeset"`
 
 Represents auditable item graph changeset.
 
-### ChangesetList
+### ChangesetList {#changesetlist}
 
 > `readonly` **ChangesetList**: `"AuditableItemGraphChangesetList"` = `"AuditableItemGraphChangesetList"`
 
 Represents auditable item graph changeset list.
 
-### PatchOperation
+### PatchOperation {#patchoperation}
 
 > `readonly` **PatchOperation**: `"AuditableItemGraphPatchOperation"` = `"AuditableItemGraphPatchOperation"`
 
 Represents patch operation.
+
+### VertexVersionList {#vertexversionlist}
+
+> `readonly` **VertexVersionList**: `"AuditableItemGraphVertexVersionList"` = `"AuditableItemGraphVertexVersionList"`
+
+Represents auditable item graph vertex version list.
+
+### PartialVertex {#partialvertex}
+
+> `readonly` **PartialVertex**: `"AuditableItemGraphPartialVertex"` = `"AuditableItemGraphPartialVertex"`
+
+Represents auditable item graph partial vertex.
+
+### ListPatch {#listpatch}
+
+> `readonly` **ListPatch**: `"AuditableItemGraphListPatch"` = `"AuditableItemGraphListPatch"`
+
+Represents auditable item graph list patch.

package/docs/reference/variables/VerifyDepth.md

@@ -6,19 +6,19 @@ How deep to verify the signatures.
 
 ## Type Declaration
 
-### None
+### None {#none}
 
 > `readonly` **None**: `"none"` = `"none"`
 
 Do not verify any signatures.
 
-### Current
+### Current {#current}
 
 > `readonly` **Current**: `"current"` = `"current"`
 
 Verify only the most recent signature.
 
-### All
+### All {#all}
 
 > `readonly` **All**: `"all"` = `"all"`