@twin.org/document-management-models 0.0.1-next.1 → 0.0.1-next.11

package/docs/changelog.md

@@ -1,5 +1,33 @@
 # @twin.org/document-management-models - Changelog
 
-## v0.0.1-next.1
+## [0.0.1-next.11](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.10...document-management-models-v0.0.1-next.11) (2025-04-28)
+
+
+### Features
+
+* document get can perform extraction ([#6](https://github.com/twinfoundation/document-management/issues/6)) ([5ce6d37](https://github.com/twinfoundation/document-management/commit/5ce6d37432ad271ca5783f422846f4be98ec2215))
+
+## [0.0.1-next.10](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.9...document-management-models-v0.0.1-next.10) (2025-04-25)
+
+
+### Miscellaneous Chores
+
+* **document-management-models:** Synchronize repo versions
+
+## [0.0.1-next.9](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.8...document-management-models-v0.0.1-next.9) (2025-04-17)
+
+
+### Features
+
+* store document as a vertex ([#2](https://github.com/twinfoundation/document-management/issues/2)) ([7febedc](https://github.com/twinfoundation/document-management/commit/7febedc3fb31de9c19565d6326341046834f2c74))
+
+## [0.0.1-next.8](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.7...document-management-models-v0.0.1-next.8) (2025-03-28)
+
+
+### Features
+
+* improve comments ([4d2f094](https://github.com/twinfoundation/document-management/commit/4d2f094b23e3320cb739917246c1ee5f6ad41c11))
+
+## v0.0.1-next.7
 
 - Initial Release

package/docs/reference/index.md

@@ -3,19 +3,23 @@
 ## Interfaces
 
 - [IDocument](interfaces/IDocument.md)
+- [IDocumentAttestation](interfaces/IDocumentAttestation.md)
 - [IDocumentList](interfaces/IDocumentList.md)
 - [IDocumentManagementComponent](interfaces/IDocumentManagementComponent.md)
+- [IDocumentManagementCreateRequest](interfaces/IDocumentManagementCreateRequest.md)
 - [IDocumentManagementGetRequest](interfaces/IDocumentManagementGetRequest.md)
 - [IDocumentManagementGetResponse](interfaces/IDocumentManagementGetResponse.md)
 - [IDocumentManagementQueryRequest](interfaces/IDocumentManagementQueryRequest.md)
 - [IDocumentManagementQueryResponse](interfaces/IDocumentManagementQueryResponse.md)
 - [IDocumentManagementRemoveRequest](interfaces/IDocumentManagementRemoveRequest.md)
-- [IDocumentManagementSetRequest](interfaces/IDocumentManagementSetRequest.md)
+- [IDocumentManagementUpdateRequest](interfaces/IDocumentManagementUpdateRequest.md)
 
 ## Type Aliases
 
+- [DocumentContexts](type-aliases/DocumentContexts.md)
 - [DocumentTypes](type-aliases/DocumentTypes.md)
 
 ## Variables
 
+- [DocumentContexts](variables/DocumentContexts.md)
 - [DocumentTypes](variables/DocumentTypes.md)

package/docs/reference/interfaces/IDocument.md

@@ -92,6 +92,14 @@ The additional JSON-LD for blob storage if it was requested.
 
 ***
 
+### extractedData?
+
+> `optional` **extractedData**: `unknown`
+
+The data extracted from the document using data extraction services.
+
+***
+
 ### attestationId?
 
 > `optional` **attestationId**: `string`
@@ -132,16 +140,16 @@ The date/time of when the document was deleted, as we never actually remove item
 
 ***
 
-### revisions?
+### nodeIdentity
 
-> `optional` **revisions**: [`IDocument`](IDocument.md)[]
+> **nodeIdentity**: `string`
 
-The previous revisions of the document.
+The node which added the document to the graph.
 
 ***
 
-### revisionCursor?
+### userIdentity
 
-> `optional` **revisionCursor**: `string`
+> **userIdentity**: `string`
 
-The cursor to get the next chunk of revisions.
+The user who added the document to the graph.

package/docs/reference/interfaces/IDocumentAttestation.md

@@ -0,0 +1,59 @@
+# Interface: IDocumentAttestation
+
+Interface describing a document attestation.
+
+## Properties
+
+### @context
+
+> **@context**: \[`"https://schema.twindev.org/documents/"`, `"https://schema.twindev.org/common/"`, `"https://schema.org"`\]
+
+JSON-LD Context.
+
+***
+
+### type
+
+> **type**: `"DocumentAttestation"`
+
+JSON-LD Type.
+
+***
+
+### documentId
+
+> **documentId**: `string`
+
+The id of the document.
+
+***
+
+### documentCode
+
+> **documentCode**: `string`
+
+The code for the document type.
+
+***
+
+### documentRevision
+
+> **documentRevision**: `number`
+
+The revision of the document as a 0 based index.
+
+***
+
+### dateCreated
+
+> **dateCreated**: `string`
+
+The date/time of when the document was created.
+
+***
+
+### blobHash
+
+> **blobHash**: `string`
+
+The hash of the document being attested.

package/docs/reference/interfaces/IDocumentList.md

@@ -1,6 +1,6 @@
 # Interface: IDocumentList
 
-Interface describing a document entry list.
+Interface describing a list of document entries.
 
 ## Properties
 
@@ -28,6 +28,14 @@ The list of documents.
 
 ***
 
+### edges?
+
+> `optional` **edges**: `string`[]
+
+The ids of the other vertices which are connected to the document.
+
+***
+
 ### cursor?
 
 > `optional` **cursor**: `string`

package/docs/reference/interfaces/IDocumentManagementComponent.md

@@ -8,22 +8,16 @@ Interface describing an document management contract.
 
 ## Methods
 
-### set()
+### create()
 
-> **set**(`auditableItemGraphId`, `documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject`?, `createAttestation`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
+> **create**(`documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject?`, `auditableItemGraphEdges?`, `options?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`string`\>
 
-Store a document in an auditable item graph vertex and add its content to blob storage.
+Create a document as an auditable item graph vertex and add its content to blob storage.
 If the document id already exists and the blob data is different a new revision will be created.
 For any other changes the current revision will be updated.
 
 #### Parameters
 
-##### auditableItemGraphId
-
-`string`
-
-The auditable item graph vertex id to create the document on.
-
 ##### documentId
 
 `string`
@@ -54,12 +48,34 @@ The data to create the document with.
 
 Additional information to associate with the document.
 
-##### createAttestation?
+##### auditableItemGraphEdges?
+
+`object`[]
+
+The auditable item graph vertices to connect the document to.
+
+##### options?
+
+Additional options for the set operation.
+
+###### createAttestation?
 
 `boolean`
 
 Flag to create an attestation for the document, defaults to false.
 
+###### addAlias?
+
+`boolean`
+
+Flag to add the document id as an alias to the aig vertex, defaults to true.
+
+###### aliasAnnotationObject?
+
+`IJsonLdNodeObject`
+
+Annotation object for the alias.
+
 ##### userIdentity?
 
 `string`
@@ -76,29 +92,77 @@ The node identity to use for vault operations.
 
 `Promise`\<`string`\>
 
-The identifier for the document which includes the auditable item graph identifier.
+The auditable item graph vertex created for the document including its revision.
 
 ***
 
-### get()
+### update()
 
-> **get**(`auditableItemGraphId`, `identifier`, `options`?, `revisionCursor`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<[`IDocument`](IDocument.md)\>
+> **update**(`auditableItemGraphDocumentId`, `blob?`, `annotationObject?`, `auditableItemGraphEdges?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
 
-Get a specific document from an auditable item graph vertex.
+Update a document as an auditable item graph vertex and add its content to blob storage.
+If the blob data is different a new revision will be created.
+For any other changes the current revision will be updated.
 
 #### Parameters
 
-##### auditableItemGraphId
+##### auditableItemGraphDocumentId
 
 `string`
 
-The auditable item graph vertex id to get the document from.
+The auditable item graph vertex id which contains the document.
 
-##### identifier
+##### blob?
+
+`Uint8Array`\<`ArrayBufferLike`\>
+
+The data to update the document with.
+
+##### annotationObject?
+
+`IJsonLdNodeObject`
+
+Additional information to associate with the document.
+
+##### auditableItemGraphEdges?
+
+`object`[]
+
+The auditable item graph vertices to connect the document to, if undefined retains current connections.
+
+##### userIdentity?
+
+`string`
+
+The identity to perform the auditable item graph operation with.
+
+##### nodeIdentity?
 
 `string`
 
-The identifier of the document to get.
+The node identity to use for vault operations.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### get()
+
+> **get**(`auditableItemGraphDocumentId`, `options?`, `cursor?`, `pageSize?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<[`IDocumentList`](IDocumentList.md)\>
+
+Get a document using it's auditable item graph vertex id and optional revision.
+
+#### Parameters
+
+##### auditableItemGraphDocumentId
+
+`string`
+
+The auditable item graph vertex id which contains the document.
 
 ##### options?
 
@@ -128,18 +192,30 @@ Flag to include the attestation information for the document, defaults to false.
 
 Flag to include deleted documents, defaults to false.
 
-###### maxRevisionCount?
+###### extractRuleGroupId?
 
-`number`
+`string`
 
-Max number of revisions to return, defaults to 0.
+If provided will extract data from the document using the specified rule group id.
 
-##### revisionCursor?
+###### extractMimeType?
+
+`string`
+
+By default extraction will auto detect the mime type of the document, this can be used to override the detection.
+
+##### cursor?
 
 `string`
 
 The cursor to get the next chunk of revisions.
 
+##### pageSize?
+
+`number`
+
+Page size of items to return, defaults to 1 so only most recent is returned.
+
 ##### userIdentity?
 
 `string`
@@ -154,42 +230,32 @@ The node identity to use for vault operations.
 
 #### Returns
 
-`Promise`\<[`IDocument`](IDocument.md)\>
+`Promise`\<[`IDocumentList`](IDocumentList.md)\>
 
 The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
 
 ***
 
-### remove()
+### removeRevision()
 
-> **remove**(`auditableItemGraphId`, `identifier`, `options`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
+> **removeRevision**(`auditableItemGraphDocumentId`, `revision`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
 
-Remove a specific document from an auditable item graph vertex.
-The documents dateDeleted will be set, but can still be queried with the includeRemoved flag.
+Remove an auditable item graph vertex using it's id.
+The document dateDeleted will be set, but can still be queried with the includeRemoved flag.
 
 #### Parameters
 
-##### auditableItemGraphId
+##### auditableItemGraphDocumentId
 
 `string`
 
-The auditable item graph vertex id to remove the document from.
-
-##### identifier
-
-`string`
-
-The identifier of the document to remove.
-
-##### options?
-
-Additional options for the remove operation.
+The auditable item graph vertex id which contains the document.
 
-###### removeAllRevisions?
+##### revision
 
-`boolean`
+`number`
 
-Flag to remove all revisions of the document, defaults to false.
+The revision of the document to remove.
 
 ##### userIdentity?
 
@@ -213,39 +279,17 @@ Nothing.
 
 ### query()
 
-> **query**(`auditableItemGraphId`, `documentCodes`?, `options`?, `cursor`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<[`IDocumentList`](IDocumentList.md)\>
+> **query**(`documentId`, `cursor?`, `pageSize?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`IAuditableItemGraphVertexList`\>
 
-Query an auditable item graph vertex for documents.
+Find all the document with a specific id.
 
 #### Parameters
 
-##### auditableItemGraphId
+##### documentId
 
 `string`
 
-The auditable item graph vertex to get the documents from.
-
-##### documentCodes?
-
-`string`[]
-
-The document codes to query for, if undefined gets all document codes.
-
-##### options?
-
-Additional options for the query operation.
-
-###### includeMostRecentRevisions?
-
-`boolean`
-
-Include the most recent 5 revisions, use the individual get to retrieve more.
-
-###### includeRemoved?
-
-`boolean`
-
-Flag to include deleted documents, defaults to false.
+The document id to find in the graph.
 
 ##### cursor?
 
@@ -253,6 +297,12 @@ Flag to include deleted documents, defaults to false.
 
 The cursor to get the next chunk of documents.
 
+##### pageSize?
+
+`number`
+
+The page size to get the next chunk of documents.
+
 ##### userIdentity?
 
 `string`
@@ -267,6 +317,6 @@ The node identity to use for vault operations.
 
 #### Returns
 
-`Promise`\<[`IDocumentList`](IDocumentList.md)\>
+`Promise`\<`IAuditableItemGraphVertexList`\>
 
-The most recent revisions of each document, cursor is set if there are more documents.
+The graph vertices that contain documents referencing the specified document id.

package/docs/reference/interfaces/{IDocumentManagementSetRequest.md → IDocumentManagementCreateRequest.md}

@@ -1,23 +1,9 @@
-# Interface: IDocumentManagementSetRequest
+# Interface: IDocumentManagementCreateRequest
 
-Request to set a document in an auditable item graph vertex.
+Request to create a document as an auditable item graph vertex.
 
 ## Properties
 
-### pathParams
-
-> **pathParams**: `object`
-
-The path parameters.
-
-#### auditableItemGraphId
-
-> **auditableItemGraphId**: `string`
-
-The id of the auditable item graph vertex to store the document on.
-
-***
-
 ### body
 
 > **body**: `object`
@@ -54,8 +40,26 @@ The data to create the document with, in base64.
 
 Additional information to associate with the document.
 
+#### auditableItemGraphEdges?
+
+> `optional` **auditableItemGraphEdges**: `object`[]
+
+The auditable item graph vertices to connect the document to.
+
 #### createAttestation?
 
 > `optional` **createAttestation**: `boolean`
 
-Flag to create an attestation for the document, defaults to false
+Flag to create an attestation for the document, defaults to false.
+
+#### addAlias?
+
+> `optional` **addAlias**: `boolean`
+
+Flag to add the document id as an alias to the aig vertex, defaults to true.
+
+#### aliasAnnotationObject?
+
+> `optional` **aliasAnnotationObject**: `IJsonLdNodeObject`
+
+Annotation object for the alias.

package/docs/reference/interfaces/IDocumentManagementGetRequest.md

@@ -22,15 +22,9 @@ The headers which can be used to determine the response data type.
 
 The path parameters.
 
-#### auditableItemGraphId
+#### auditableItemGraphDocumentId
 
-> **auditableItemGraphId**: `string`
-
-The id of the auditable item graph vertex to store the document on.
-
-#### documentId
-
-> **documentId**: `string`
+> **auditableItemGraphDocumentId**: `string`
 
 The full id of the document to get.
 
@@ -90,20 +84,32 @@ Include deleted documents in the response.
 false
 ```
 
-#### maxRevisionCount?
+#### 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.
+
+#### pageSize?
 
-> `optional` **maxRevisionCount**: `number`
+> `optional` **pageSize**: `string`
 
-Max number of revisions to return.
+Page size of items to return, defaults to 1 so only most recent is returned.
 
 ##### Default
 
 ```ts
-0
+1
 ```
 
-#### revisionCursor?
+#### cursor?
 
-> `optional` **revisionCursor**: `string`
+> `optional` **cursor**: `string`
 
 The cursor to get the next chunk of revisions.

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/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`
+
+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.