@twin.org/auditable-item-graph-models 0.0.3-next.2 → 0.0.3-next.20

package/docs/reference/interfaces/IAuditableItemGraphVertex.md

@@ -8,9 +8,9 @@ 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.
 
@@ -20,9 +20,9 @@ The date/time of when the element was created.
 
 ***
 
-### dateModified?
+### dateModified? {#datemodified}
 
-> `optional` **dateModified**: `string`
+> `optional` **dateModified?**: `string`
 
 The date/time of when the element was modified.
 
@@ -32,9 +32,9 @@ The date/time of when the element was modified.
 
 ***
 
-### dateDeleted?
+### dateDeleted? {#datedeleted}
 
-> `optional` **dateDeleted**: `string`
+> `optional` **dateDeleted?**: `string`
 
 The date/time of when the element was deleted, as we never actually remove items.
 
@@ -44,7 +44,7 @@ The date/time of when the element was deleted, as we never actually remove items
 
 ***
 
-### @context
+### @context {#context}
 
 > **@context**: \[`"https://schema.twindev.org/aig/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
 
@@ -52,7 +52,7 @@ JSON-LD Context.
 
 ***
 
-### id
+### id {#id}
 
 > **id**: `string`
 
@@ -64,7 +64,7 @@ The id of the element.
 
 ***
 
-### type
+### type {#type}
 
 > **type**: `"AuditableItemGraphVertex"`
 
@@ -72,56 +72,57 @@ JSON-LD Type.
 
 ***
 
-### organizationIdentity?
+### organizationIdentity? {#organizationidentity}
 
-> `optional` **organizationIdentity**: `string`
+> `optional` **organizationIdentity?**: `string`
 
 The identity of the organization which controls the vertex.
 
 ***
 
-### annotationObject?
+### annotationObject? {#annotationobject}
 
-> `optional` **annotationObject**: `IJsonLdNodeObject`
+> `optional` **annotationObject?**: `IJsonLdNodeObject`
 
 The JSON-LD annotation object for the vertex.
 
 ***
 
-### aliases?
+### aliases? {#aliases}
 
-> `optional` **aliases**: [`IAuditableItemGraphAlias`](IAuditableItemGraphAlias.md)[]
+> `optional` **aliases?**: [`IAuditableItemGraphAlias`](IAuditableItemGraphAlias.md)[]
 
 Alternative aliases that can be used to identify the vertex.
 
 ***
 
-### resources?
+### resources? {#resources}
 
-> `optional` **resources**: [`IAuditableItemGraphResource`](IAuditableItemGraphResource.md)[]
+> `optional` **resources?**: [`IAuditableItemGraphResource`](IAuditableItemGraphResource.md)[]
 
 The resources attached to the vertex.
 
 ***
 
-### edges?
+### edges? {#edges}
 
-> `optional` **edges**: [`IAuditableItemGraphEdge`](IAuditableItemGraphEdge.md)[]
+> `optional` **edges?**: [`IAuditableItemGraphEdge`](IAuditableItemGraphEdge.md)[]
 
 Edges connected to the vertex.
 
 ***
 
-### changesets?
+### verified? {#verified}
 
-> `optional` **changesets**: [`IAuditableItemGraphChangeset`](IAuditableItemGraphChangeset.md)[]
+> `optional` **verified?**: `boolean`
 
-Changesets for the vertex.
+Is the vertex verified, will only be populated when verification is requested.
 
 ***
 
-### verified?
+### version? {#version}
 
-> `optional` **verified**: `boolean`
+> `optional` **version?**: `number`
 
-Is the vertex verified, will only be populated when verification is requested.
+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,16 +20,8 @@ JSON-LD Type.
 
 ***
 
-### itemListElement
+### itemListElement {#itemlistelement}
 
 > **itemListElement**: [`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)[]
 
 The list of vertices.
-
-***
-
-### nextItem?
-
-> `optional` **nextItem**: `string`
-
-The cursor to get the next chunk of vertices.

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,14 +6,38 @@ 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 namespace for the auditable item graph types.
+The canonical RDF namespace URI for Auditable Item Graph.
 
-### NamespaceCommon
+### 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}
+
+> `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}
 
 > `readonly` **NamespaceCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
 
-The namespace for the common types.
+The canonical RDF namespace URI for TWIN Common.
+
+### 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}
+
+> `readonly` **JsonLdContextCommon**: `"https://schema.twindev.org/common/types.jsonld"` = `"https://schema.twindev.org/common/types.jsonld"`
+
+The JSON-LD Context URL for TWIN Common.

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,44 +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.
+Represents auditable item graph changeset.
 
-### PatchOperation
+### ChangesetList {#changesetlist}
+
+> `readonly` **ChangesetList**: `"AuditableItemGraphChangesetList"` = `"AuditableItemGraphChangesetList"`
+
+Represents auditable item graph changeset list.
+
+### 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"`
 

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/auditable-item-graph-models",
-	"version": "0.0.3-next.2",
-	"description": "Models which define the structure of the auditable item graph connectors and services",
+	"version": "0.0.3-next.20",
+	"description": "Defines shared graph data contracts, JSON schemas, and JSON-LD contexts for consistent interoperability.",
 	"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-models"
 	},
 	"author": "martyn.janes@iota.org",
@@ -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",
@@ -51,7 +52,7 @@
 		"schemas"
 	],
 	"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"
 }