@3sixty/auditable-item-graph-models 0.0.0-stage → 0.20.0-next.0

package/docs/reference/interfaces/IAuditableItemGraphVertex.md

@@ -0,0 +1,139 @@
+# Interface: IAuditableItemGraphVertex
+
+Interface describing an auditable item graph vertex.
+
+## Extends
+
+- `Omit`\<[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md), `"deleted"`\>
+
+## Properties
+
+### dateCreated? {#datecreated}
+
+> `optional` **dateCreated?**: `string`
+
+The date/time of when the element was created.
+
+#### Inherited from
+
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`dateCreated`](IAuditableItemGraphAuditedElement.md#datecreated)
+
+***
+
+### dateModified? {#datemodified}
+
+> `optional` **dateModified?**: `string`
+
+The date/time of when the element was modified.
+
+#### Inherited from
+
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`dateModified`](IAuditableItemGraphAuditedElement.md#datemodified)
+
+***
+
+### dateDeleted? {#datedeleted}
+
+> `optional` **dateDeleted?**: `string`
+
+The date/time of when the element was deleted, as we never actually remove items.
+
+#### Inherited from
+
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`dateDeleted`](IAuditableItemGraphAuditedElement.md#datedeleted)
+
+***
+
+### @context {#context}
+
+> **@context**: \[`"https://schema.3sixty.global/aig/"`, `"https://schema.3sixty.global/common/"`, `...IJsonLdContextDefinitionElement[]`\]
+
+JSON-LD Context.
+
+***
+
+### id {#id}
+
+> **id**: `string`
+
+The id of the element.
+
+#### Overrides
+
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`id`](IAuditableItemGraphAuditedElement.md#id)
+
+***
+
+### type {#type}
+
+> **type**: `"AuditableItemGraphVertex"`
+
+JSON-LD Type.
+
+***
+
+### organizationIdentity? {#organizationidentity}
+
+> `optional` **organizationIdentity?**: `string`
+
+The identity of the organization which controls the vertex.
+
+***
+
+### auditMode? {#auditmode}
+
+> `optional` **auditMode?**: [`AuditableItemGraphAuditMode`](../type-aliases/AuditableItemGraphAuditMode.md)
+
+How the mutations of the vertex are recorded, when absent the vertex behaves as audited.
+Once a vertex is set to bypass it can not be returned to audited.
+
+***
+
+### annotationObject? {#annotationobject}
+
+> `optional` **annotationObject?**: `IJsonLdNodeObject`
+
+The JSON-LD annotation object for the vertex.
+
+***
+
+### aliases? {#aliases}
+
+> `optional` **aliases?**: [`IAuditableItemGraphAlias`](IAuditableItemGraphAlias.md)[]
+
+Alternative aliases that can be used to identify the vertex.
+
+***
+
+### resources? {#resources}
+
+> `optional` **resources?**: [`IAuditableItemGraphResource`](IAuditableItemGraphResource.md)[]
+
+The resources attached to the vertex.
+
+***
+
+### edges? {#edges}
+
+> `optional` **edges?**: [`IAuditableItemGraphEdge`](IAuditableItemGraphEdge.md)[]
+
+Edges connected to the vertex.
+
+***
+
+### verified? {#verified}
+
+> `optional` **verified?**: `boolean`
+
+Is the vertex verified, will only be populated when verification is requested.
+Always undefined when the vertex is in bypass mode.
+
+***
+
+### version? {#version}
+
+> `optional` **version?**: `number`
+
+The version of the vertex, populated only when getting a specific version.
+Always undefined when the vertex is in bypass mode.
+Maps to https://schema.org/version.

package/docs/reference/interfaces/IAuditableItemGraphVertexList.md

@@ -0,0 +1,27 @@
+# Interface: IAuditableItemGraphVertexList
+
+Interface describing an auditable item graph vertex list.
+
+## Properties
+
+### @context {#context}
+
+> **@context**: \[`"https://schema.org"`, `"https://schema.3sixty.global/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
+
+JSON-LD Context.
+
+***
+
+### type {#type}
+
+> **type**: \[`"ItemList"`, `"AuditableItemGraphVertexList"`\]
+
+JSON-LD Type.
+
+***
+
+### itemListElement {#itemlistelement}
+
+> **itemListElement**: [`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md)[]
+
+The list 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.3sixty.global/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/AuditableItemGraphAuditMode.md

@@ -0,0 +1,5 @@
+# Type Alias: AuditableItemGraphAuditMode
+
+> **AuditableItemGraphAuditMode** = *typeof* [`AuditableItemGraphAuditMode`](../variables/AuditableItemGraphAuditMode.md)\[keyof *typeof* [`AuditableItemGraphAuditMode`](../variables/AuditableItemGraphAuditMode.md)\]
+
+How the mutations of a vertex are recorded.

package/docs/reference/type-aliases/AuditableItemGraphContexts.md

@@ -0,0 +1,5 @@
+# Type Alias: AuditableItemGraphContexts
+
+> **AuditableItemGraphContexts** = *typeof* [`AuditableItemGraphContexts`](../variables/AuditableItemGraphContexts.md)\[keyof *typeof* [`AuditableItemGraphContexts`](../variables/AuditableItemGraphContexts.md)\]
+
+The contexts of auditable item graph data.

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

@@ -0,0 +1,5 @@
+# Type Alias: AuditableItemGraphTopics
+
+> **AuditableItemGraphTopics** = *typeof* [`AuditableItemGraphTopics`](../variables/AuditableItemGraphTopics.md)\[keyof *typeof* [`AuditableItemGraphTopics`](../variables/AuditableItemGraphTopics.md)\]
+
+The topics for auditable item graph event bus notifications.

package/docs/reference/type-aliases/AuditableItemGraphTypes.md

@@ -0,0 +1,5 @@
+# Type Alias: AuditableItemGraphTypes
+
+> **AuditableItemGraphTypes** = *typeof* [`AuditableItemGraphTypes`](../variables/AuditableItemGraphTypes.md)\[keyof *typeof* [`AuditableItemGraphTypes`](../variables/AuditableItemGraphTypes.md)\]
+
+The types of auditable item graph data.

package/docs/reference/type-aliases/VerifyDepth.md

@@ -0,0 +1,5 @@
+# Type Alias: VerifyDepth
+
+> **VerifyDepth** = *typeof* [`VerifyDepth`](../variables/VerifyDepth.md)\[keyof *typeof* [`VerifyDepth`](../variables/VerifyDepth.md)\]
+
+How deep to verify the signatures.

package/docs/reference/variables/AuditableItemGraphAuditMode.md

@@ -0,0 +1,19 @@
+# Variable: AuditableItemGraphAuditMode
+
+> `const` **AuditableItemGraphAuditMode**: `object`
+
+How the mutations of a vertex are recorded.
+
+## Type Declaration
+
+### Audited {#audited}
+
+> `readonly` **Audited**: `"audited"` = `"audited"`
+
+Every mutation appends a new version entry and maintains a full audit trail.
+
+### Bypass {#bypass}
+
+> `readonly` **Bypass**: `"bypass"` = `"bypass"`
+
+Mutations overwrite the stored state in place, with no version chain or audit entries.

package/docs/reference/variables/AuditableItemGraphContexts.md

@@ -0,0 +1,43 @@
+# Variable: AuditableItemGraphContexts
+
+> `const` **AuditableItemGraphContexts**: `object`
+
+The contexts of auditable item graph data.
+
+## Type Declaration
+
+### Namespace {#namespace}
+
+> `readonly` **Namespace**: `"https://schema.3sixty.global/aig/"` = `"https://schema.3sixty.global/aig/"`
+
+The canonical RDF namespace URI for Auditable Item Graph.
+
+### Context {#context}
+
+> `readonly` **Context**: `"https://schema.3sixty.global/aig/"` = `"https://schema.3sixty.global/aig/"`
+
+The value to use in context for Auditable Item Graph.
+
+### JsonLdContext {#jsonldcontext}
+
+> `readonly` **JsonLdContext**: `"https://schema.3sixty.global/aig/types.jsonld"` = `"https://schema.3sixty.global/aig/types.jsonld"`
+
+The JSON-LD Context URL for Auditable Item Graph.
+
+### NamespaceCommon {#namespacecommon}
+
+> `readonly` **NamespaceCommon**: `"https://schema.3sixty.global/common/"` = `"https://schema.3sixty.global/common/"`
+
+The canonical RDF namespace URI for TWIN Common.
+
+### ContextCommon {#contextcommon}
+
+> `readonly` **ContextCommon**: `"https://schema.3sixty.global/common/"` = `"https://schema.3sixty.global/common/"`
+
+The value to use in JSON-LD context for TWIN Common.
+
+### JsonLdContextCommon {#jsonldcontextcommon}
+
+> `readonly` **JsonLdContextCommon**: `"https://schema.3sixty.global/common/types.jsonld"` = `"https://schema.3sixty.global/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

@@ -0,0 +1,19 @@
+# Variable: AuditableItemGraphTopics
+
+> `const` **AuditableItemGraphTopics**: `object`
+
+The topics for auditable item graph event bus notifications.
+
+## Type Declaration
+
+### VertexCreated {#vertexcreated}
+
+> `readonly` **VertexCreated**: `"auditable-item-graph:vertex-created"` = `"auditable-item-graph:vertex-created"`
+
+A vertex was created.
+
+### VertexUpdated {#vertexupdated}
+
+> `readonly` **VertexUpdated**: `"auditable-item-graph:vertex-updated"` = `"auditable-item-graph:vertex-updated"`
+
+A vertex was updated.

package/docs/reference/variables/AuditableItemGraphTypes.md

@@ -0,0 +1,79 @@
+# Variable: AuditableItemGraphTypes
+
+> `const` **AuditableItemGraphTypes**: `object`
+
+The types of auditable item graph data.
+
+## Type Declaration
+
+### Vertex {#vertex}
+
+> `readonly` **Vertex**: `"AuditableItemGraphVertex"` = `"AuditableItemGraphVertex"`
+
+Represents auditable item graph vertex.
+
+### VertexList {#vertexlist}
+
+> `readonly` **VertexList**: `"AuditableItemGraphVertexList"` = `"AuditableItemGraphVertexList"`
+
+Represents auditable item graph vertex list.
+
+### Alias {#alias}
+
+> `readonly` **Alias**: `"AuditableItemGraphAlias"` = `"AuditableItemGraphAlias"`
+
+Represents auditable item graph alias.
+
+### Resource {#resource}
+
+> `readonly` **Resource**: `"AuditableItemGraphResource"` = `"AuditableItemGraphResource"`
+
+Represents auditable item graph resource.
+
+### Edge {#edge}
+
+> `readonly` **Edge**: `"AuditableItemGraphEdge"` = `"AuditableItemGraphEdge"`
+
+Represents auditable item graph edge.
+
+### Changeset {#changeset}
+
+> `readonly` **Changeset**: `"AuditableItemGraphChangeset"` = `"AuditableItemGraphChangeset"`
+
+Represents auditable item graph changeset.
+
+### 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.
+
+### AuditMode {#auditmode}
+
+> `readonly` **AuditMode**: `"AuditableItemGraphAuditMode"` = `"AuditableItemGraphAuditMode"`
+
+Represents auditable item graph audit mode.

package/docs/reference/variables/CompiledAuditableItemGraphAlias.md

@@ -0,0 +1,5 @@
+# Variable: CompiledAuditableItemGraphAlias
+
+> `const` **CompiledAuditableItemGraphAlias**: `ICompiledValidator` = `validate53`
+
+Compiled validator for the AuditableItemGraphAlias schema.

package/docs/reference/variables/CompiledAuditableItemGraphAuditMode.md

@@ -0,0 +1,5 @@
+# Variable: CompiledAuditableItemGraphAuditMode
+
+> `const` **CompiledAuditableItemGraphAuditMode**: `ICompiledValidator` = `validate52`
+
+Compiled validator for the AuditableItemGraphAuditMode schema.

package/docs/reference/variables/CompiledAuditableItemGraphAuditedElement.md

@@ -0,0 +1,5 @@
+# Variable: CompiledAuditableItemGraphAuditedElement
+
+> `const` **CompiledAuditableItemGraphAuditedElement**: `ICompiledValidator` = `validate54`
+
+Compiled validator for the AuditableItemGraphAuditedElement schema.

package/docs/reference/variables/CompiledAuditableItemGraphChangeset.md

@@ -0,0 +1,5 @@
+# Variable: CompiledAuditableItemGraphChangeset
+
+> `const` **CompiledAuditableItemGraphChangeset**: `ICompiledValidator` = `validate56`
+
+Compiled validator for the AuditableItemGraphChangeset schema.

package/docs/reference/variables/CompiledAuditableItemGraphChangesetList.md

@@ -0,0 +1,5 @@
+# Variable: CompiledAuditableItemGraphChangesetList
+
+> `const` **CompiledAuditableItemGraphChangesetList**: `ICompiledValidator` = `validate59`
+
+Compiled validator for the AuditableItemGraphChangesetList schema.

package/docs/reference/variables/CompiledAuditableItemGraphEdge.md

@@ -0,0 +1,5 @@
+# Variable: CompiledAuditableItemGraphEdge
+
+> `const` **CompiledAuditableItemGraphEdge**: `ICompiledValidator` = `validate61`
+
+Compiled validator for the AuditableItemGraphEdge schema.

package/docs/reference/variables/CompiledAuditableItemGraphListPatch.md

@@ -0,0 +1,5 @@
+# Variable: CompiledAuditableItemGraphListPatch
+
+> `const` **CompiledAuditableItemGraphListPatch**: `ICompiledValidator` = `validate63`
+
+Compiled validator for the AuditableItemGraphListPatch schema.

package/docs/reference/variables/CompiledAuditableItemGraphPartialVertex.md

@@ -0,0 +1,5 @@
+# Variable: CompiledAuditableItemGraphPartialVertex
+
+> `const` **CompiledAuditableItemGraphPartialVertex**: `ICompiledValidator` = `validate69`
+
+Compiled validator for the AuditableItemGraphPartialVertex schema.

package/docs/reference/variables/CompiledAuditableItemGraphPatchOperation.md

@@ -0,0 +1,5 @@
+# Variable: CompiledAuditableItemGraphPatchOperation
+
+> `const` **CompiledAuditableItemGraphPatchOperation**: `ICompiledValidator` = `validate57`
+
+Compiled validator for the AuditableItemGraphPatchOperation schema.

package/docs/reference/variables/CompiledAuditableItemGraphResource.md

@@ -0,0 +1,5 @@
+# Variable: CompiledAuditableItemGraphResource
+
+> `const` **CompiledAuditableItemGraphResource**: `ICompiledValidator` = `validate66`
+
+Compiled validator for the AuditableItemGraphResource schema.

package/docs/reference/variables/CompiledAuditableItemGraphVertex.md

@@ -0,0 +1,5 @@
+# Variable: CompiledAuditableItemGraphVertex
+
+> `const` **CompiledAuditableItemGraphVertex**: `ICompiledValidator` = `validate74`
+
+Compiled validator for the AuditableItemGraphVertex schema.

package/docs/reference/variables/CompiledAuditableItemGraphVertexList.md

@@ -0,0 +1,5 @@
+# Variable: CompiledAuditableItemGraphVertexList
+
+> `const` **CompiledAuditableItemGraphVertexList**: `ICompiledValidator` = `validate79`
+
+Compiled validator for the AuditableItemGraphVertexList schema.

package/docs/reference/variables/CompiledAuditableItemGraphVertexVersionList.md

@@ -0,0 +1,5 @@
+# Variable: CompiledAuditableItemGraphVertexVersionList
+
+> `const` **CompiledAuditableItemGraphVertexVersionList**: `ICompiledValidator` = `validate81`
+
+Compiled validator for the AuditableItemGraphVertexVersionList schema.

package/docs/reference/variables/VerifyDepth.md

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

package/locales/en.json

@@ -0,0 +1,3 @@
+{
+	"error": {}
+}