@3sixty/document-management-models 0.0.0-stage → 0.20.0-next.1

package/docs/reference/interfaces/IDocumentManagementCreateRequest.md

@@ -0,0 +1,53 @@
+# Interface: IDocumentManagementCreateRequest
+
+Request to create a document as an auditable item graph vertex.
+
+## Properties
+
+### body {#body}
+
+> **body**: `object`
+
+The body parameters.
+
+#### document
+
+> **document**: [`IDocumentBase`](IDocumentBase.md)
+
+The document base properties.
+
+#### blob
+
+> **blob**: `string`
+
+The data to create the document with, either as base64-encoded content or an existing blob storage entry id.
+
+#### auditableItemGraphEdges?
+
+> `optional` **auditableItemGraphEdges?**: [`IDocumentManagementEdgeEntry`](IDocumentManagementEdgeEntry.md)[]
+
+The auditable item graph vertices to connect the document to.
+
+#### options?
+
+> `optional` **options?**: `object`
+
+Additional options for the create operation.
+
+##### options.includeAttestation?
+
+> `optional` **includeAttestation?**: `boolean`
+
+Flag to create an attestation for the document, defaults to false.
+
+##### options.includeAlias?
+
+> `optional` **includeAlias?**: `boolean`
+
+Flag to add the document id as an alias to the aig vertex, defaults to true.
+
+##### options.aliasAnnotationObject?
+
+> `optional` **aliasAnnotationObject?**: `IJsonLdNodeObject`
+
+Annotation object for the alias.

package/docs/reference/interfaces/IDocumentManagementEdgeEntry.md

@@ -0,0 +1,27 @@
+# Interface: IDocumentManagementEdgeEntry
+
+A single edge entry used when connecting a document to an AIG vertex.
+
+## Properties
+
+### targetId {#targetid}
+
+> **targetId**: `string`
+
+The target AIG vertex id to connect to.
+
+***
+
+### includeAlias? {#includealias}
+
+> `optional` **includeAlias?**: `boolean`
+
+Whether to add the document id as an alias on the connected vertex, defaults to false.
+
+***
+
+### aliasAnnotationObject? {#aliasannotationobject}
+
+> `optional` **aliasAnnotationObject?**: `IJsonLdNodeObject`
+
+Annotation object for the alias, if includeAlias is true.

package/docs/reference/interfaces/IDocumentManagementGetRequest.md

@@ -0,0 +1,127 @@
+# Interface: IDocumentManagementGetRequest
+
+Request to get a document from 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 path parameters.
+
+#### auditableItemGraphDocumentId
+
+> **auditableItemGraphDocumentId**: `string`
+
+The full id of the document to get.
+
+***
+
+### query? {#query}
+
+> `optional` **query?**: `object`
+
+The query parameters.
+
+#### includeBlobStorageMetadata?
+
+> `optional` **includeBlobStorageMetadata?**: `string`
+
+Include the blob storage metadata in the response.
+
+##### Default
+
+```ts
+false
+```
+
+#### includeBlobStorageData?
+
+> `optional` **includeBlobStorageData?**: `string`
+
+Include the blob storage data in the response.
+
+##### Default
+
+```ts
+false
+```
+
+#### includeAttestation?
+
+> `optional` **includeAttestation?**: `string`
+
+Include the attestation information in the response.
+
+##### Default
+
+```ts
+false
+```
+
+#### includeRemoved?
+
+> `optional` **includeRemoved?**: `string`
+
+Include deleted documents in the response.
+
+##### Default
+
+```ts
+false
+```
+
+#### includeDeletedEdges?
+
+> `optional` **includeDeletedEdges?**: `string`
+
+Include soft-deleted edges in the response.
+
+##### Default
+
+```ts
+false
+```
+
+#### extractRuleGroupId?
+
+> `optional` **extractRuleGroupId?**: `string`
+
+If provided will extract data from the document using the specified rule group id.
+
+#### extractMimeType?
+
+> `optional` **extractMimeType?**: `string`
+
+By default extraction will auto detect the mime type of the document, this can be used to override the detection.
+
+#### limit?
+
+> `optional` **limit?**: `string`
+
+Limit the number of items to return, defaults to 1 so only most recent is returned.
+
+##### Default
+
+```ts
+1
+```
+
+#### cursor?
+
+> `optional` **cursor?**: `string`
+
+The cursor to get the next chunk of revisions.

package/docs/reference/interfaces/IDocumentManagementGetResponse.md

@@ -0,0 +1,27 @@
+# Interface: IDocumentManagementGetResponse
+
+Response to get a document and optionally revisions from an auditable item graph vertex.
+
+## 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**: [`IDocumentList`](IDocumentList.md)
+
+The body parameters.

package/docs/reference/interfaces/IDocumentManagementGetRevisionRequest.md

@@ -0,0 +1,91 @@
+# Interface: IDocumentManagementGetRevisionRequest
+
+Request to get a document revision from 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 path parameters.
+
+#### auditableItemGraphDocumentId
+
+> **auditableItemGraphDocumentId**: `string`
+
+The full id of the document to get.
+
+#### revision
+
+> **revision**: `string`
+
+The revision of the document to get.
+
+***
+
+### query? {#query}
+
+> `optional` **query?**: `object`
+
+The query parameters.
+
+#### includeBlobStorageMetadata?
+
+> `optional` **includeBlobStorageMetadata?**: `string`
+
+Include the blob storage metadata in the response.
+
+##### Default
+
+```ts
+false
+```
+
+#### includeBlobStorageData?
+
+> `optional` **includeBlobStorageData?**: `string`
+
+Include the blob storage data in the response.
+
+##### Default
+
+```ts
+false
+```
+
+#### includeAttestation?
+
+> `optional` **includeAttestation?**: `string`
+
+Include the attestation information in the response.
+
+##### Default
+
+```ts
+false
+```
+
+#### extractRuleGroupId?
+
+> `optional` **extractRuleGroupId?**: `string`
+
+If provided will extract data from the document using the specified rule group id.
+
+#### extractMimeType?
+
+> `optional` **extractMimeType?**: `string`
+
+By default extraction will auto detect the mime type of the document, this can be used to override the detection.

package/docs/reference/interfaces/IDocumentManagementGetRevisionResponse.md

@@ -0,0 +1,23 @@
+# Interface: IDocumentManagementGetRevisionResponse
+
+Response to get a document revision from an auditable item graph vertex.
+
+## 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"`
+
+***
+
+### body {#body}
+
+> **body**: [`IDocument`](IDocument.md)
+
+The body parameters.

package/docs/reference/interfaces/IDocumentManagementQueryRequest.md

@@ -0,0 +1,41 @@
+# Interface: IDocumentManagementQueryRequest
+
+Request to query a list of documents from 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"`
+
+***
+
+### query {#query}
+
+> **query**: `object`
+
+The query parameters.
+
+#### documentId
+
+> **documentId**: `string`
+
+The id of the document id we are trying to find.
+
+#### cursor?
+
+> `optional` **cursor?**: `string`
+
+The cursor to get the next chunk of documents.
+
+#### limit?
+
+> `optional` **limit?**: `string`
+
+The number of documents to return.

package/docs/reference/interfaces/IDocumentManagementQueryResponse.md

@@ -0,0 +1,27 @@
+# Interface: IDocumentManagementQueryResponse
+
+Response to query the documents from an auditable item graph vertex.
+
+## 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`
+
+The body parameters.

package/docs/reference/interfaces/IDocumentManagementRemoveRequest.md

@@ -0,0 +1,23 @@
+# Interface: IDocumentManagementRemoveRequest
+
+Request to remove a document revision from an auditable item graph.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### auditableItemGraphDocumentId
+
+> **auditableItemGraphDocumentId**: `string`
+
+The id of the auditable item graph vertex to remove the revision from.
+
+#### revision
+
+> **revision**: `string`
+
+The revision of the document to remove.

package/docs/reference/interfaces/IDocumentManagementUpdatePartialRequest.md

@@ -0,0 +1,80 @@
+# Interface: IDocumentManagementUpdatePartialRequest
+
+Request to partially update a document as an auditable item graph vertex.
+
+## Properties
+
+### pathParams {#pathparams}
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### auditableItemGraphDocumentId
+
+> **auditableItemGraphDocumentId**: `string`
+
+The full id of the document to update.
+
+***
+
+### body {#body}
+
+> **body**: `object`
+
+The body parameters.
+
+#### document?
+
+> `optional` **document?**: `Partial`\<`Pick`\<[`IDocumentBase`](IDocumentBase.md), `"documentCode"` \| `"annotationObject"` \| `"documentIdFormat"`\>\>
+
+The document base properties to update. annotationObject, documentIdFormat and documentCode are applied in-place to the current revision.
+
+#### blob?
+
+> `optional` **blob?**: `string`
+
+The data to update the document with, either as base64-encoded content or an existing blob storage entry id.
+
+#### auditableItemGraphEdges?
+
+> `optional` **auditableItemGraphEdges?**: `object`
+
+Explicit edge delta to apply. Use `add` to create new connections and `remove` to
+disconnect existing ones by their target vertex id.
+
+##### auditableItemGraphEdges.add?
+
+> `optional` **add?**: [`IDocumentManagementEdgeEntry`](IDocumentManagementEdgeEntry.md)[]
+
+Connections to add; each entry creates a back-edge on the connected vertex.
+
+##### auditableItemGraphEdges.remove?
+
+> `optional` **remove?**: `string`[]
+
+Target vertex IDs to disconnect; their back-edges are removed.
+
+#### options?
+
+> `optional` **options?**: `object`
+
+Additional options for the update operation.
+
+##### options.includeAttestation?
+
+> `optional` **includeAttestation?**: `boolean`
+
+Set to true to start attesting the document (even if originally created without attestation), or false to remove the existing attestation. Omit to leave attestation state unchanged.
+
+##### options.includeAlias?
+
+> `optional` **includeAlias?**: `boolean`
+
+Set to true to add the document id as an alias on the aig vertex, or false to remove it. Omit to leave alias state unchanged.
+
+##### options.aliasAnnotationObject?
+
+> `optional` **aliasAnnotationObject?**: `IJsonLdNodeObject`
+
+Annotation object for the alias when adding.

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

@@ -0,0 +1,5 @@
+# Type Alias: DocumentContexts
+
+> **DocumentContexts** = *typeof* [`DocumentContexts`](../variables/DocumentContexts.md)\[keyof *typeof* [`DocumentContexts`](../variables/DocumentContexts.md)\]
+
+The contexts of document management objects.

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

@@ -0,0 +1,5 @@
+# Type Alias: DocumentManagementMetricIds
+
+> **DocumentManagementMetricIds** = *typeof* [`DocumentManagementMetricIds`](../variables/DocumentManagementMetricIds.md)\[keyof *typeof* [`DocumentManagementMetricIds`](../variables/DocumentManagementMetricIds.md)\]
+
+Metric IDs for the document management service.

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

@@ -0,0 +1,5 @@
+# Type Alias: DocumentTypes
+
+> **DocumentTypes** = *typeof* [`DocumentTypes`](../variables/DocumentTypes.md)\[keyof *typeof* [`DocumentTypes`](../variables/DocumentTypes.md)\]
+
+The types of document management objects.

package/docs/reference/variables/CompiledDocument.md

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

package/docs/reference/variables/CompiledDocumentAttestation.md

@@ -0,0 +1,5 @@
+# Variable: CompiledDocumentAttestation
+
+> `const` **CompiledDocumentAttestation**: `ICompiledValidator` = `validate55`
+
+Compiled validator for the DocumentAttestation schema.

package/docs/reference/variables/CompiledDocumentBase.md

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

package/docs/reference/variables/CompiledDocumentHydrated.md

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

package/docs/reference/variables/CompiledDocumentList.md

@@ -0,0 +1,5 @@
+# Variable: CompiledDocumentList
+
+> `const` **CompiledDocumentList**: `ICompiledValidator` = `validate58`
+
+Compiled validator for the DocumentList schema.

package/docs/reference/variables/DocumentContexts.md

@@ -0,0 +1,43 @@
+# Variable: DocumentContexts
+
+> `const` **DocumentContexts**: `object`
+
+The contexts of document management objects.
+
+## Type Declaration
+
+### Namespace {#namespace}
+
+> `readonly` **Namespace**: `"https://schema.3sixty.global/documents/"` = `"https://schema.3sixty.global/documents/"`
+
+The canonical RDF namespace URI for Document Management.
+
+### Context {#context}
+
+> `readonly` **Context**: `"https://schema.3sixty.global/documents/"` = `"https://schema.3sixty.global/documents/"`
+
+The value to use in context for Document Management.
+
+### JsonLdContext {#jsonldcontext}
+
+> `readonly` **JsonLdContext**: `"https://schema.3sixty.global/documents/types.jsonld"` = `"https://schema.3sixty.global/documents/types.jsonld"`
+
+The JSON-LD Context URL for Document Management.
+
+### 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/DocumentManagementMetricIds.md

@@ -0,0 +1,37 @@
+# Variable: DocumentManagementMetricIds
+
+> `const` **DocumentManagementMetricIds**: `object`
+
+Metric IDs for the document management service.
+
+## Type Declaration
+
+### DocumentsCreated {#documentscreated}
+
+> `readonly` **DocumentsCreated**: `"dm_documents_created"` = `"dm_documents_created"`
+
+Number of documents created.
+
+### DocumentsUpdated {#documentsupdated}
+
+> `readonly` **DocumentsUpdated**: `"dm_documents_updated"` = `"dm_documents_updated"`
+
+Number of documents updated.
+
+### RevisionsCreated {#revisionscreated}
+
+> `readonly` **RevisionsCreated**: `"dm_revisions_created"` = `"dm_revisions_created"`
+
+Number of document revisions created.
+
+### RevisionsRemoved {#revisionsremoved}
+
+> `readonly` **RevisionsRemoved**: `"dm_revisions_removed"` = `"dm_revisions_removed"`
+
+Number of document revisions removed.
+
+### AttestationsCreated {#attestationscreated}
+
+> `readonly` **AttestationsCreated**: `"dm_attestations_created"` = `"dm_attestations_created"`
+
+Number of document attestations created.

package/docs/reference/variables/DocumentManagementMetrics.md

@@ -0,0 +1,5 @@
+# Variable: DocumentManagementMetrics
+
+> `const` **DocumentManagementMetrics**: `ITelemetryMetric`[]
+
+Metrics registered by the document management service.