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

package/docs/reference/interfaces/IAuditableItemGraphListRequest.md

@@ -0,0 +1,84 @@
+# Interface: IAuditableItemGraphListRequest
+
+Get the a list of the vertices with matching ids or aliases.
+
+## 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"`
+
+***
+
+### query? {#query}
+
+> `optional` **query?**: `object`
+
+The query parameters.
+
+#### id?
+
+> `optional` **id?**: `string`
+
+The id or alias to try and find.
+
+#### idMode?
+
+> `optional` **idMode?**: `"id"` \| `"alias"` \| `"both"`
+
+Which field to look in with the id, defaults to both.
+
+#### idExact?
+
+> `optional` **idExact?**: `string`
+
+Find only exact matches, default to false meaning partial matching.
+
+#### resourceTypes?
+
+> `optional` **resourceTypes?**: `string`
+
+Include vertices with specific resource types, comma separated.
+
+#### conditions?
+
+> `optional` **conditions?**: `string`
+
+The conditions to filter the streams, JSON stringified `EntityCondition<IAuditableItemGraphVertex>`.
+
+#### orderBy?
+
+> `optional` **orderBy?**: `"dateCreated"` \| `"dateModified"`
+
+The order for the results, default to dateCreated.
+
+#### orderByDirection?
+
+> `optional` **orderByDirection?**: `SortDirection`
+
+The direction for the order, defaults to desc.
+
+#### properties?
+
+> `optional` **properties?**: `string`
+
+The properties to return as a comma separated list, defaults to "id,dateCreated,aliases,annotationObject".
+
+#### cursor?
+
+> `optional` **cursor?**: `string`
+
+The optional cursor to get next chunk.
+
+#### limit?
+
+> `optional` **limit?**: `string`
+
+The maximum number of entities to return, a page can contain fewer so follow the cursor
+until it is absent to read them all.

package/docs/reference/interfaces/IAuditableItemGraphListResponse.md

@@ -0,0 +1,27 @@
+# Interface: IAuditableItemGraphListResponse
+
+The response to getting the a list of the vertices with matching ids or aliases.
+
+## Properties
+
+### headers? {#headers}
+
+> `optional` **headers?**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### content-type
+
+> **content-type**: `"application/json"` \| `"application/ld+json"`
+
+#### link?
+
+> `optional` **link?**: `string` \| `string`[]
+
+***
+
+### body {#body}
+
+> **body**: [`IAuditableItemGraphVertexList`](IAuditableItemGraphVertexList.md)
+
+The response payload.

package/docs/reference/interfaces/IAuditableItemGraphPartialVertex.md

@@ -0,0 +1,164 @@
+# Interface: IAuditableItemGraphPartialVertex
+
+Partial vertex payload for updatePartial.
+Sub-lists use explicit `{ add, remove }` patches; bare arrays are not supported.
+
+## Extends
+
+- `Omit`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md), `"type"` \| `"aliases"` \| `"edges"` \| `"resources"`\>
+
+## 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)
+
+***
+
+### id {#id}
+
+> **id**: `string`
+
+The id of the vertex to update.
+
+#### Overrides
+
+[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md).[`id`](IAuditableItemGraphVertex.md#id)
+
+***
+
+### @context {#context}
+
+> **@context**: \[`"https://schema.3sixty.global/aig/"`, `"https://schema.3sixty.global/common/"`, `...IJsonLdContextDefinitionElement[]`\]
+
+JSON-LD Context.
+
+#### Overrides
+
+`Omit.@context`
+
+***
+
+### type? {#type}
+
+> `optional` **type?**: `"AuditableItemGraphVertex"`
+
+JSON-LD Type.
+
+***
+
+### aliasPatches? {#aliaspatches}
+
+> `optional` **aliasPatches?**: [`IAuditableItemGraphListPatch`](IAuditableItemGraphListPatch.md)\<[`IAuditableItemGraphAlias`](IAuditableItemGraphAlias.md)\>
+
+Patch operations for aliases.
+
+***
+
+### resourcePatches? {#resourcepatches}
+
+> `optional` **resourcePatches?**: [`IAuditableItemGraphListPatch`](IAuditableItemGraphListPatch.md)\<[`IAuditableItemGraphResource`](IAuditableItemGraphResource.md)\>
+
+Patch operations for resources.
+
+***
+
+### edgePatches? {#edgepatches}
+
+> `optional` **edgePatches?**: [`IAuditableItemGraphListPatch`](IAuditableItemGraphListPatch.md)\<[`IAuditableItemGraphEdge`](IAuditableItemGraphEdge.md)\>
+
+Patch operations for edges.
+
+***
+
+### organizationIdentity? {#organizationidentity}
+
+> `optional` **organizationIdentity?**: `string`
+
+The identity of the organization which controls the vertex.
+
+#### Inherited from
+
+[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md).[`organizationIdentity`](IAuditableItemGraphVertex.md#organizationidentity)
+
+***
+
+### 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.
+
+#### Inherited from
+
+[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md).[`auditMode`](IAuditableItemGraphVertex.md#auditmode)
+
+***
+
+### annotationObject? {#annotationobject}
+
+> `optional` **annotationObject?**: `IJsonLdNodeObject`
+
+The JSON-LD annotation object for the vertex.
+
+#### Inherited from
+
+[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md).[`annotationObject`](IAuditableItemGraphVertex.md#annotationobject)
+
+***
+
+### 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.
+
+#### Inherited from
+
+[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md).[`verified`](IAuditableItemGraphVertex.md#verified)
+
+***
+
+### 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.
+
+#### Inherited from
+
+[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md).[`version`](IAuditableItemGraphVertex.md#version)

package/docs/reference/interfaces/IAuditableItemGraphPatchOperation.md

@@ -0,0 +1,51 @@
+# Interface: IAuditableItemGraphPatchOperation
+
+The patch operation for JSON diffs.
+
+## Properties
+
+### @context? {#context}
+
+> `optional` **@context?**: `"https://schema.3sixty.global/aig/"` \| \[`"https://schema.3sixty.global/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
+
+JSON-LD Context.
+
+***
+
+### type {#type}
+
+> **type**: `"AuditableItemGraphPatchOperation"`
+
+JSON-LD Type.
+
+***
+
+### patchOperation {#patchoperation}
+
+> **patchOperation**: `"add"` \| `"remove"` \| `"replace"` \| `"move"` \| `"copy"` \| `"test"`
+
+The operation that was performed on the item.
+
+***
+
+### patchPath {#patchpath}
+
+> **patchPath**: `string`
+
+The path to the object that was changed.
+
+***
+
+### patchFrom? {#patchfrom}
+
+> `optional` **patchFrom?**: `string`
+
+The path the value was copied or moved from.
+
+***
+
+### patchValue? {#patchvalue}
+
+> `optional` **patchValue?**: `unknown`
+
+The value to add.

package/docs/reference/interfaces/IAuditableItemGraphRemoveProofRequest.md

@@ -0,0 +1,17 @@
+# Interface: IAuditableItemGraphRemoveProofRequest
+
+Remove the notarization proof from all changesets of a graph vertex.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The parameters from the path.
+
+#### id
+
+> **id**: `string`
+
+The id of the vertex whose proof should be removed.

package/docs/reference/interfaces/IAuditableItemGraphResource.md

@@ -0,0 +1,79 @@
+# Interface: IAuditableItemGraphResource
+
+Interface describing an auditable item graph vertex resource.
+
+## Extends
+
+- [`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md)
+
+## Properties
+
+### id? {#id}
+
+> `optional` **id?**: `string`
+
+The id of the element.
+
+#### Inherited from
+
+[`IAuditableItemGraphAuditedElement`](IAuditableItemGraphAuditedElement.md).[`id`](IAuditableItemGraphAuditedElement.md#id)
+
+***
+
+### 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}
+
+> `optional` **@context?**: `"https://schema.3sixty.global/aig/"` \| \[`"https://schema.3sixty.global/aig/"`, `...IJsonLdContextDefinitionElement[]`\]
+
+JSON-LD Context.
+
+***
+
+### type {#type}
+
+> **type**: `"AuditableItemGraphResource"`
+
+JSON-LD Type.
+
+***
+
+### resourceObject? {#resourceobject}
+
+> `optional` **resourceObject?**: `IJsonLdNodeObject`
+
+The JSON-LD object for the resource.

package/docs/reference/interfaces/IAuditableItemGraphUpdatePartialRequest.md

@@ -0,0 +1,26 @@
+# Interface: IAuditableItemGraphUpdatePartialRequest
+
+Partially update an auditable item graph vertex (PATCH - explicit list patches).
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### id
+
+> **id**: `string`
+
+The id of the vertex to update.
+
+***
+
+### body {#body}
+
+> **body**: `Omit`\<[`IAuditableItemGraphPartialVertex`](IAuditableItemGraphPartialVertex.md), `"id"`\>
+
+Partial vertex data; only defined properties are applied.
+Sub-lists use `{ add, remove }` patch objects.

package/docs/reference/interfaces/IAuditableItemGraphUpdateRequest.md

@@ -0,0 +1,25 @@
+# Interface: IAuditableItemGraphUpdateRequest
+
+Update an auditable item graph vertex (PUT - full replacement of vertex state).
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### id
+
+> **id**: `string`
+
+The id of the vertex to update.
+
+***
+
+### body {#body}
+
+> **body**: `Omit`\<[`IAuditableItemGraphVertex`](IAuditableItemGraphVertex.md), `"id"`\>
+
+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.