@twin.org/document-management-models 0.0.1-next.2 → 0.0.1-next.20

package/docs/reference/interfaces/IDocumentManagementGetResponse.md

@@ -18,6 +18,6 @@ The headers which can be used to determine the response data type.
 
 ### body
 
-> **body**: [`IDocument`](IDocument.md)
+> **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?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept
+
+> **accept**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### 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?
+
+> `optional` **query**: `object`
+
+The query parameters.
+
+#### includeBlobStorageMetadata?
+
+> `optional` **includeBlobStorageMetadata**: `string` \| `boolean`
+
+Include the blob storage metadata in the response.
+
+##### Default
+
+```ts
+false
+```
+
+#### includeBlobStorageData?
+
+> `optional` **includeBlobStorageData**: `string` \| `boolean`
+
+Include the blob storage data in the response.
+
+##### Default
+
+```ts
+false
+```
+
+#### includeAttestation?
+
+> `optional` **includeAttestation**: `string` \| `boolean`
+
+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?
+
+> `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**: [`IDocument`](IDocument.md)
+
+The body parameters.

package/docs/reference/interfaces/IDocumentManagementQueryRequest.md

@@ -16,58 +16,26 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### pathParams
+### query
 
-> **pathParams**: `object`
-
-The path parameters.
-
-#### auditableItemGraphId
-
-> **auditableItemGraphId**: `string`
-
-The id of the auditable item graph vertex which contains the documents.
-
-***
-
-### query?
-
-> `optional` **query**: `object`
+> **query**: `object`
 
 The query parameters.
 
-#### documentCodes?
-
-> `optional` **documentCodes**: `string`
-
-List of comma separated document codes to filter the query.
-
-#### includeRemoved?
+#### documentId
 
-> `optional` **includeRemoved**: `boolean`
+> **documentId**: `string`
 
-Include deleted documents in the response.
-
-##### Default
-
-```ts
-false
-```
-
-#### includeMostRecentRevisions?
-
-> `optional` **includeMostRecentRevisions**: `boolean`
-
-Include the most recent 5 revisions, use the individual get to retrieve more.
-
-##### Default
-
-```ts
-false
-```
+The id of the document id we are trying to find.
 
 #### cursor?
 
 > `optional` **cursor**: `string`
 
 The cursor to get the next chunk of documents.
+
+#### pageSize?
+
+> `optional` **pageSize**: `string` \| `number`
+
+The number of documents to return.

package/docs/reference/interfaces/IDocumentManagementQueryResponse.md

@@ -18,6 +18,6 @@ The headers which can be used to determine the response data type.
 
 ### body
 
-> **body**: [`IDocumentList`](IDocumentList.md)
+> **body**: `IAuditableItemGraphVertexList`
 
 The body parameters.

package/docs/reference/interfaces/IDocumentManagementRemoveRequest.md

@@ -1,6 +1,6 @@
 # Interface: IDocumentManagementRemoveRequest
 
-Request to remove a document from an auditable item graph.
+Request to remove a document revision from an auditable item graph.
 
 ## Properties
 
@@ -10,34 +10,14 @@ Request to remove a document from an auditable item graph.
 
 The path parameters.
 
-#### auditableItemGraphId
+#### auditableItemGraphDocumentId
 
-> **auditableItemGraphId**: `string`
+> **auditableItemGraphDocumentId**: `string`
 
-The id of the auditable item graph vertex to remove the document from.
+The id of the auditable item graph vertex to remove the revision from.
 
-#### documentId
+#### revision
 
-> **documentId**: `string`
+> **revision**: `string`
 
-The full id of the document to remove.
-
-***
-
-### query?
-
-> `optional` **query**: `object`
-
-The query parameters.
-
-#### removeAllRevisions?
-
-> `optional` **removeAllRevisions**: `boolean`
-
-Flag to remove all revisions of the document.
-
-##### Default
-
-```ts
-false
-```
+The revision of the document to remove.

package/docs/reference/interfaces/IDocumentManagementUpdateRequest.md

@@ -0,0 +1,43 @@
+# Interface: IDocumentManagementUpdateRequest
+
+Request to update a document as an auditable item graph vertex.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### auditableItemGraphDocumentId
+
+> **auditableItemGraphDocumentId**: `string`
+
+The full id of the document to get.
+
+***
+
+### body
+
+> **body**: `object`
+
+The body parameters.
+
+#### blob?
+
+> `optional` **blob**: `string`
+
+The data to create the document with, in base64.
+
+#### annotationObject?
+
+> `optional` **annotationObject**: `IJsonLdNodeObject`
+
+Additional information to associate with the document.
+
+#### auditableItemGraphEdges?
+
+> `optional` **auditableItemGraphEdges**: `object`[]
+
+The auditable item graph vertices to connect the document to.

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/DocumentTypes.md

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

package/docs/reference/variables/DocumentContexts.md

@@ -0,0 +1,19 @@
+# Variable: DocumentContexts
+
+> `const` **DocumentContexts**: `object`
+
+The contexts of document management objects.
+
+## Type declaration
+
+### ContextRoot
+
+> `readonly` **ContextRoot**: `"https://schema.twindev.org/documents/"` = `"https://schema.twindev.org/documents/"`
+
+The context root for the document types.
+
+### ContextRootCommon
+
+> `readonly` **ContextRootCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
+
+The context root for the common types.

package/docs/reference/variables/DocumentTypes.md

@@ -6,26 +6,14 @@ The types of document management objects.
 
 ## Type declaration
 
-### ContextRoot
-
-> `readonly` **ContextRoot**: `"https://schema.twindev.org/documents/"` = `"https://schema.twindev.org/documents/"`
-
-The context root for the document types.
-
-### ContextRootCommon
-
-> `readonly` **ContextRootCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
-
-The context root for the common types.
-
 ### Document
 
 > `readonly` **Document**: `"Document"` = `"Document"`
 
 Represents a document.
 
-### DocumentList
+### DocumentAttestation
 
-> `readonly` **DocumentList**: `"DocumentList"` = `"DocumentList"`
+> `readonly` **DocumentAttestation**: `"DocumentAttestation"` = `"DocumentAttestation"`
 
-Represents a document list.
+Represents a document attestation.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/document-management-models",
-	"version": "0.0.1-next.2",
+	"version": "0.0.1-next.20",
 	"description": "Models which define the structure of the document management connectors and services",
 	"repository": {
 		"type": "git",
@@ -15,8 +15,10 @@
 	},
 	"dependencies": {
 		"@twin.org/attestation-models": "next",
+		"@twin.org/auditable-item-graph-models": "next",
 		"@twin.org/blob-storage-models": "next",
 		"@twin.org/core": "next",
+		"@twin.org/data-core": "next",
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-schema-org": "next",

package/dist/types/models/documentDataTypes.d.ts

@@ -1,25 +0,0 @@
-/**
- * The types of document management objects.
- */
-export declare const DocumentTypes: {
-    /**
-     * The context root for the document types.
-     */
-    readonly ContextRoot: "https://schema.twindev.org/documents/";
-    /**
-     * The context root for the common types.
-     */
-    readonly ContextRootCommon: "https://schema.twindev.org/common/";
-    /**
-     * Represents a document.
-     */
-    readonly Document: "Document";
-    /**
-     * Represents a document list.
-     */
-    readonly DocumentList: "DocumentList";
-};
-/**
- * The types of document management objects.
- */
-export type DocumentTypes = (typeof DocumentTypes)[keyof typeof DocumentTypes];