@twin.org/auditable-item-graph-models 0.0.3-next.0 → 0.0.3-next.10

package/docs/reference/interfaces/IAuditableItemGraphPatchOperation.md

@@ -4,9 +4,9 @@ The patch operation for JSON diffs.
 
 ## Properties
 
-### @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.
 
@@ -25,6 +25,7 @@ JSON-LD Type.
 > **patchOperation**: `"add"` \| `"remove"` \| `"replace"` \| `"move"` \| `"copy"` \| `"test"`
 
 The operation that was performed on the item.
+json-ld type:sch:Text
 
 ***
 
@@ -33,6 +34,7 @@ The operation that was performed on the item.
 > **patchPath**: `string`
 
 The path to the object that was changed.
+json-ld type:sch:Text
 
 ***
 
@@ -41,6 +43,7 @@ The path to the object that was changed.
 > `optional` **patchFrom**: `string`
 
 The path the value was copied or moved from.
+json-ld type:sch:Text
 
 ***
 
@@ -49,3 +52,4 @@ The path the value was copied or moved from.
 > `optional` **patchValue**: `unknown`
 
 The value to add.
+json-ld type:json

package/docs/reference/interfaces/IAuditableItemGraphResource.md

@@ -25,6 +25,7 @@ The id of the element.
 > `optional` **dateCreated**: `string`
 
 The date/time of when the element was created.
+json-ld namespace:sch
 
 #### Inherited from
 
@@ -37,6 +38,7 @@ The date/time of when the element was created.
 > `optional` **dateModified**: `string`
 
 The date/time of when the element was modified.
+json-ld namespace:sch
 
 #### Inherited from
 
@@ -49,6 +51,7 @@ The date/time of when the element was modified.
 > `optional` **dateDeleted**: `string`
 
 The date/time of when the element was deleted, as we never actually remove items.
+json-ld namespace:sch
 
 #### Inherited from
 
@@ -77,3 +80,4 @@ JSON-LD Type.
 > `optional` **resourceObject**: `IJsonLdNodeObject`
 
 The JSON-LD object for the resource.
+json-ld type:json

package/docs/reference/interfaces/IAuditableItemGraphVertex.md

@@ -13,6 +13,7 @@ Interface describing an auditable item graph vertex.
 > `optional` **dateCreated**: `string`
 
 The date/time of when the element was created.
+json-ld namespace:sch
 
 #### Inherited from
 
@@ -25,6 +26,7 @@ The date/time of when the element was created.
 > `optional` **dateModified**: `string`
 
 The date/time of when the element was modified.
+json-ld namespace:sch
 
 #### Inherited from
 
@@ -37,6 +39,7 @@ The date/time of when the element was modified.
 > `optional` **dateDeleted**: `string`
 
 The date/time of when the element was deleted, as we never actually remove items.
+json-ld namespace:sch
 
 #### Inherited from
 
@@ -77,6 +80,7 @@ JSON-LD Type.
 > `optional` **organizationIdentity**: `string`
 
 The identity of the organization which controls the vertex.
+json-ld namespace:twin-common
 
 ***
 
@@ -85,6 +89,7 @@ The identity of the organization which controls the vertex.
 > `optional` **annotationObject**: `IJsonLdNodeObject`
 
 The JSON-LD annotation object for the vertex.
+json-ld namespace:twin-common
 
 ***
 
@@ -93,6 +98,7 @@ The JSON-LD annotation object for the vertex.
 > `optional` **aliases**: [`IAuditableItemGraphAlias`](IAuditableItemGraphAlias.md)[]
 
 Alternative aliases that can be used to identify the vertex.
+json-ld container:set
 
 ***
 
@@ -101,6 +107,7 @@ Alternative aliases that can be used to identify the vertex.
 > `optional` **resources**: [`IAuditableItemGraphResource`](IAuditableItemGraphResource.md)[]
 
 The resources attached to the vertex.
+json-ld container:set
 
 ***
 
@@ -109,14 +116,7 @@ The resources attached to the vertex.
 > `optional` **edges**: [`IAuditableItemGraphEdge`](IAuditableItemGraphEdge.md)[]
 
 Edges connected to the vertex.
-
-***
-
-### changesets?
-
-> `optional` **changesets**: [`IAuditableItemGraphChangeset`](IAuditableItemGraphChangeset.md)[]
-
-Changesets for the vertex.
+json-ld container:set
 
 ***
 
@@ -125,3 +125,4 @@ Changesets for the vertex.
 > `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

@@ -25,11 +25,4 @@ JSON-LD Type.
 > **itemListElement**: [`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)[]
 
 The list of vertices.
-
-***
-
-### nextItem?
-
-> `optional` **nextItem**: `string`
-
-The cursor to get the next chunk of vertices.
+json-ld namespace:sch

package/docs/reference/variables/AuditableItemGraphContexts.md

@@ -6,14 +6,38 @@ The contexts of auditable item graph data.
 
 ## Type Declaration
 
-### ContextRoot
+### Namespace
 
-> `readonly` **ContextRoot**: `"https://schema.twindev.org/aig/"` = `"https://schema.twindev.org/aig/"`
+> `readonly` **Namespace**: `"https://schema.twindev.org/aig/"` = `"https://schema.twindev.org/aig/"`
 
-The context root for the auditable item graph types.
+The canonical RDF namespace URI for Auditable Item Graph.
 
-### ContextRootCommon
+### Context
 
-> `readonly` **ContextRootCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
+> `readonly` **Context**: `"https://schema.twindev.org/aig/"` = `"https://schema.twindev.org/aig/"`
 
-The context root for the common types.
+The value to use in context for Auditable Item Graph.
+
+### 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
+
+> `readonly` **NamespaceCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
+
+The canonical RDF namespace URI for TWIN Common.
+
+### 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
+
+> `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/AuditableItemGraphTypes.md

@@ -40,7 +40,13 @@ Represents auditable item graph edge.
 
 > `readonly` **Changeset**: `"AuditableItemGraphChangeset"` = `"AuditableItemGraphChangeset"`
 
-Represents auditable item graph  changeset.
+Represents auditable item graph changeset.
+
+### ChangesetList
+
+> `readonly` **ChangesetList**: `"AuditableItemGraphChangesetList"` = `"AuditableItemGraphChangesetList"`
+
+Represents auditable item graph changeset list.
 
 ### PatchOperation
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/auditable-item-graph-models",
-	"version": "0.0.3-next.0",
+	"version": "0.0.3-next.10",
 	"description": "Models which define the structure of the auditable item graph connectors and services",
 	"repository": {
 		"type": "git",