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

package/docs/reference/interfaces/IAuditableItemGraphListRequest.md

@@ -4,9 +4,9 @@ Get the a list of the vertices with matching ids or aliases.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,68 +16,68 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### query?
+### query? {#query}
 
-> `optional` **query**: `object`
+> `optional` **query?**: `object`
 
 The query parameters.
 
 #### id?
 
-> `optional` **id**: `string`
+> `optional` **id?**: `string`
 
 The id or alias to try and find.
 
 #### idMode?
 
-> `optional` **idMode**: `"id"` \| `"alias"` \| `"both"`
+> `optional` **idMode?**: `"id"` \| `"alias"` \| `"both"`
 
 Which field to look in with the id, defaults to both.
 
 #### idExact?
 
-> `optional` **idExact**: `string`
+> `optional` **idExact?**: `string`
 
 Find only exact matches, default to false meaning partial matching.
 
 #### resourceTypes?
 
-> `optional` **resourceTypes**: `string`
+> `optional` **resourceTypes?**: `string`
 
 Include vertices with specific resource types, comma separated.
 
 #### conditions?
 
-> `optional` **conditions**: `string`
+> `optional` **conditions?**: `string`
 
 The conditions to filter the streams, JSON stringified IComparator[].
 
 #### orderBy?
 
-> `optional` **orderBy**: `"dateCreated"` \| `"dateModified"`
+> `optional` **orderBy?**: `"dateCreated"` \| `"dateModified"`
 
 The order for the results, default to dateCreated.
 
 #### orderByDirection?
 
-> `optional` **orderByDirection**: `SortDirection`
+> `optional` **orderByDirection?**: `SortDirection`
 
 The direction for the order, defaults to desc.
 
 #### properties?
 
-> `optional` **properties**: `string`
+> `optional` **properties?**: `string`
 
 The properties to return as a comma separated list, defaults to "id,dateCreated,aliases,annotationObject".
 
 #### cursor?
 
-> `optional` **cursor**: `string`
+> `optional` **cursor?**: `string`
 
 The optional cursor to get next chunk.
 
 #### limit?
 
-> `optional` **limit**: `string`
+> `optional` **limit?**: `string`
 
 Limit the number of entities to return.

package/docs/reference/interfaces/IAuditableItemGraphListResponse.md

@@ -4,9 +4,9 @@ The response to getting the a list of the vertices with matching ids or aliases.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,11 +16,11 @@ The headers which can be used to determine the response data type.
 
 #### link?
 
-> `optional` **link**: `string` \| `string`[]
+> `optional` **link?**: `string` \| `string`[]
 
 ***
 
-### body
+### body {#body}
 
 > **body**: [`IAuditableItemGraphVertexList`](IAuditableItemGraphVertexList.md)
 

package/docs/reference/interfaces/IAuditableItemGraphPatchOperation.md

@@ -4,15 +4,15 @@ The patch operation for JSON diffs.
 
 ## Properties
 
-### @context?
+### @context? {#context}
 
-> `optional` **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
+> `optional` **@context?**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 
 ***
 
-### type
+### type {#type}
 
 > **type**: `"AuditableItemGraphPatchOperation"`
 
@@ -20,36 +20,32 @@ JSON-LD Type.
 
 ***
 
-### patchOperation
+### patchOperation {#patchoperation}
 
 > **patchOperation**: `"add"` \| `"remove"` \| `"replace"` \| `"move"` \| `"copy"` \| `"test"`
 
 The operation that was performed on the item.
-json-ld type:sch:Text
 
 ***
 
-### patchPath
+### patchPath {#patchpath}
 
 > **patchPath**: `string`
 
 The path to the object that was changed.
-json-ld type:sch:Text
 
 ***
 
-### patchFrom?
+### patchFrom? {#patchfrom}
 
-> `optional` **patchFrom**: `string`
+> `optional` **patchFrom?**: `string`
 
 The path the value was copied or moved from.
-json-ld type:sch:Text
 
 ***
 
-### patchValue?
+### patchValue? {#patchvalue}
 
-> `optional` **patchValue**: `unknown`
+> `optional` **patchValue?**: `unknown`
 
 The value to add.
-json-ld type:json

package/docs/reference/interfaces/IAuditableItemGraphResource.md

@@ -8,9 +8,9 @@ Interface describing an auditable item graph vertex resource.
 
 ## Properties
 
-### id?
+### id? {#id}
 
-> `optional` **id**: `string`
+> `optional` **id?**: `string`
 
 The id of the element.
 
@@ -20,12 +20,11 @@ The id of the element.
 
 ***
 
-### dateCreated?
+### dateCreated? {#datecreated}
 
-> `optional` **dateCreated**: `string`
+> `optional` **dateCreated?**: `string`
 
 The date/time of when the element was created.
-json-ld namespace:sch
 
 #### Inherited from
 
@@ -33,12 +32,11 @@ json-ld namespace:sch
 
 ***
 
-### dateModified?
+### dateModified? {#datemodified}
 
-> `optional` **dateModified**: `string`
+> `optional` **dateModified?**: `string`
 
 The date/time of when the element was modified.
-json-ld namespace:sch
 
 #### Inherited from
 
@@ -46,12 +44,11 @@ json-ld namespace:sch
 
 ***
 
-### 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:sch
 
 #### Inherited from
 
@@ -59,15 +56,15 @@ json-ld namespace:sch
 
 ***
 
-### @context
+### @context? {#context}
 
-> **@context**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
+> `optional` **@context?**: `"https://schema.twindev.org/aig/"` \| \[`"https://schema.twindev.org/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 
 ***
 
-### type
+### type {#type}
 
 > **type**: `"AuditableItemGraphResource"`
 
@@ -75,9 +72,8 @@ JSON-LD Type.
 
 ***
 
-### resourceObject?
+### resourceObject? {#resourceobject}
 
-> `optional` **resourceObject**: `IJsonLdNodeObject`
+> `optional` **resourceObject?**: `IJsonLdNodeObject`
 
 The JSON-LD object for the resource.
-json-ld type:json

package/docs/reference/interfaces/IAuditableItemGraphUpdateRequest.md

@@ -4,7 +4,7 @@ Update an auditable item graph vertex.
 
 ## 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.

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:sch
 
 #### Inherited from
 
@@ -21,12 +20,11 @@ json-ld namespace:sch
 
 ***
 
-### dateModified?
+### dateModified? {#datemodified}
 
-> `optional` **dateModified**: `string`
+> `optional` **dateModified?**: `string`
 
 The date/time of when the element was modified.
-json-ld namespace:sch
 
 #### Inherited from
 
@@ -34,12 +32,11 @@ json-ld namespace:sch
 
 ***
 
-### 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:sch
 
 #### Inherited from
 
@@ -47,7 +44,7 @@ json-ld namespace:sch
 
 ***
 
-### @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,48 @@ 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

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:sch

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/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,49 +6,49 @@ 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"`
 

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.11",
-	"description": "Models which define the structure of the auditable item graph connectors and services",
+	"version": "0.0.3-next.13",
+	"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/auditable-item-graph.git",
 		"directory": "packages/auditable-item-graph-models"
 	},
 	"author": "martyn.janes@iota.org",
@@ -51,7 +51,7 @@
 		"schemas"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/auditable-item-graph/issues"
+		"url": "git+https://github.com/iotaledger/auditable-item-graph/issues"
 	},
 	"homepage": "https://twindev.org"
 }