@twin.org/document-management-models 0.0.3-next.11 → 0.0.3-next.13

package/docs/reference/interfaces/IDocumentAttestation.md

@@ -4,7 +4,7 @@ Interface describing a document attestation.
 
 ## Properties
 
-### @context
+### @context {#context}
 
 > **@context**: \[`"https://schema.org"`, `"https://schema.twindev.org/documents/"`, `"https://schema.twindev.org/common/"`\]
 
@@ -12,7 +12,7 @@ JSON-LD Context.
 
 ***
 
-### type
+### type {#type}
 
 > **type**: `"DocumentAttestation"`
 
@@ -20,45 +20,40 @@ JSON-LD Type.
 
 ***
 
-### documentId
+### documentId {#documentid}
 
 > **documentId**: `string`
 
 The id of the document.
-json-ld type:schema:identifier
 
 ***
 
-### documentCode
+### documentCode {#documentcode}
 
 > **documentCode**: `UneceDocumentCodeList`
 
 The code for the document type.
-json-ld type:schema:identifier
 
 ***
 
-### documentRevision
+### documentRevision {#documentrevision}
 
 > **documentRevision**: `number`
 
 The revision of the document as a 0 based index.
-json-ld type:schema:Integer
 
 ***
 
-### dateCreated
+### dateCreated {#datecreated}
 
 > **dateCreated**: `string`
 
 The date/time of when the document was created.
-json-ld namespace:schema
 
 ***
 
-### integrity
+### integrity {#integrity}
 
 > **integrity**: `string`
 
 The integrity of the document being attested.
-json-ld namespace:twin-common

package/docs/reference/interfaces/IDocumentList.md

@@ -4,7 +4,7 @@ Interface describing a list of document entries.
 
 ## Properties
 
-### @context
+### @context {#context}
 
 > **@context**: \[`"https://schema.org"`, `"https://schema.twindev.org/documents/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
 
@@ -12,7 +12,7 @@ JSON-LD Context.
 
 ***
 
-### type
+### type {#type}
 
 > **type**: `"ItemList"`
 
@@ -20,18 +20,16 @@ JSON-LD Type.
 
 ***
 
-### itemListElement
+### itemListElement {#itemlistelement}
 
 > **itemListElement**: [`IDocument`](IDocument.md)[]
 
 The list of documents.
-json-ld namespace:schema
 
 ***
 
-### edges?
+### edges? {#edges}
 
-> `optional` **edges**: `string`[]
+> `optional` **edges?**: `string`[]
 
 The ids of the other vertices which are connected to the document.
-json-ld container:set

package/docs/reference/interfaces/IDocumentManagementComponent.md

@@ -8,7 +8,7 @@ Interface describing an document management contract.
 
 ## Methods
 
-### create()
+### create() {#create}
 
 > **create**(`documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject?`, `auditableItemGraphEdges?`, `options?`): `Promise`\<`string`\>
 
@@ -26,9 +26,9 @@ The document id to create.
 
 ##### documentIdFormat
 
-The format of the document identifier.
+`string` \| `undefined`
 
-`string` | `undefined`
+The format of the document identifier.
 
 ##### documentCode
 
@@ -84,7 +84,7 @@ The auditable item graph vertex created for the document including its revision.
 
 ***
 
-### update()
+### update() {#update}
 
 > **update**(`auditableItemGraphDocumentId`, `blob?`, `annotationObject?`, `auditableItemGraphEdges?`): `Promise`\<`void`\>
 
@@ -126,7 +126,7 @@ Nothing.
 
 ***
 
-### get()
+### get() {#get}
 
 > **get**(`auditableItemGraphDocumentId`, `options?`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: [`IDocumentList`](IDocumentList.md); `cursor?`: `string`; \}\>
 
@@ -200,7 +200,7 @@ The documents and revisions if requested, ordered by revision descending, cursor
 
 ***
 
-### getRevision()
+### getRevision() {#getrevision}
 
 > **getRevision**(`auditableItemGraphDocumentId`, `revision`, `options?`): `Promise`\<[`IDocument`](IDocument.md)\>
 
@@ -262,7 +262,7 @@ The documents and revisions if requested, ordered by revision descending, cursor
 
 ***
 
-### removeRevision()
+### removeRevision() {#removerevision}
 
 > **removeRevision**(`auditableItemGraphDocumentId`, `revision`): `Promise`\<`void`\>
 
@@ -291,7 +291,7 @@ Nothing.
 
 ***
 
-### query()
+### query() {#query}
 
 > **query**(`documentId`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: `IAuditableItemGraphVertexList`; `cursor?`: `string`; \}\>
 

package/docs/reference/interfaces/IDocumentManagementCreateRequest.md

@@ -4,7 +4,7 @@ Request to create a document as an auditable item graph vertex.
 
 ## Properties
 
-### body
+### body {#body}
 
 > **body**: `object`
 
@@ -36,30 +36,30 @@ The data to create the document with, in base64.
 
 #### annotationObject?
 
-> `optional` **annotationObject**: `IJsonLdNodeObject`
+> `optional` **annotationObject?**: `IJsonLdNodeObject`
 
 Additional information to associate with the document.
 
 #### auditableItemGraphEdges?
 
-> `optional` **auditableItemGraphEdges**: `object`[]
+> `optional` **auditableItemGraphEdges?**: `object`[]
 
 The auditable item graph vertices to connect the document to.
 
 #### createAttestation?
 
-> `optional` **createAttestation**: `boolean`
+> `optional` **createAttestation?**: `boolean`
 
 Flag to create an attestation for the document, defaults to false.
 
 #### addAlias?
 
-> `optional` **addAlias**: `boolean`
+> `optional` **addAlias?**: `boolean`
 
 Flag to add the document id as an alias to the aig vertex, defaults to true.
 
 #### aliasAnnotationObject?
 
-> `optional` **aliasAnnotationObject**: `IJsonLdNodeObject`
+> `optional` **aliasAnnotationObject?**: `IJsonLdNodeObject`
 
 Annotation object for the alias.

package/docs/reference/interfaces/IDocumentManagementGetRequest.md

@@ -4,9 +4,9 @@ Request to get a document from an auditable item graph vertex.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,7 +16,7 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -30,15 +30,15 @@ The full id of the document to get.
 
 ***
 
-### query?
+### query? {#query}
 
-> `optional` **query**: `object`
+> `optional` **query?**: `object`
 
 The query parameters.
 
 #### includeBlobStorageMetadata?
 
-> `optional` **includeBlobStorageMetadata**: `string`
+> `optional` **includeBlobStorageMetadata?**: `string`
 
 Include the blob storage metadata in the response.
 
@@ -50,7 +50,7 @@ false
 
 #### includeBlobStorageData?
 
-> `optional` **includeBlobStorageData**: `string`
+> `optional` **includeBlobStorageData?**: `string`
 
 Include the blob storage data in the response.
 
@@ -62,7 +62,7 @@ false
 
 #### includeAttestation?
 
-> `optional` **includeAttestation**: `string`
+> `optional` **includeAttestation?**: `string`
 
 Include the attestation information in the response.
 
@@ -74,7 +74,7 @@ false
 
 #### includeRemoved?
 
-> `optional` **includeRemoved**: `string`
+> `optional` **includeRemoved?**: `string`
 
 Include deleted documents in the response.
 
@@ -86,19 +86,19 @@ false
 
 #### extractRuleGroupId?
 
-> `optional` **extractRuleGroupId**: `string`
+> `optional` **extractRuleGroupId?**: `string`
 
 If provided will extract data from the document using the specified rule group id.
 
 #### extractMimeType?
 
-> `optional` **extractMimeType**: `string`
+> `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`
+> `optional` **limit?**: `string`
 
 PLimit the number of items to return, defaults to 1 so only most recent is returned.
 
@@ -110,6 +110,6 @@ PLimit the number of items to return, defaults to 1 so only most recent is retur
 
 #### cursor?
 
-> `optional` **cursor**: `string`
+> `optional` **cursor?**: `string`
 
 The cursor to get the next chunk of revisions.

package/docs/reference/interfaces/IDocumentManagementGetResponse.md

@@ -4,9 +4,9 @@ Response to get a document and optionally revisions from an auditable item graph
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,11 +16,11 @@ The headers which can be used to determine the response data type.
 
 #### link?
 
-> `optional` **link**: `string` \| `string`[]
+> `optional` **link?**: `string` \| `string`[]
 
 ***
 
-### body
+### body {#body}
 
 > **body**: [`IDocumentList`](IDocumentList.md)
 

package/docs/reference/interfaces/IDocumentManagementGetRevisionRequest.md

@@ -4,9 +4,9 @@ Request to get a document revision from an auditable item graph vertex.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,7 +16,7 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -36,15 +36,15 @@ The revision of the document to get.
 
 ***
 
-### query?
+### query? {#query}
 
-> `optional` **query**: `object`
+> `optional` **query?**: `object`
 
 The query parameters.
 
 #### includeBlobStorageMetadata?
 
-> `optional` **includeBlobStorageMetadata**: `string`
+> `optional` **includeBlobStorageMetadata?**: `string`
 
 Include the blob storage metadata in the response.
 
@@ -56,7 +56,7 @@ false
 
 #### includeBlobStorageData?
 
-> `optional` **includeBlobStorageData**: `string`
+> `optional` **includeBlobStorageData?**: `string`
 
 Include the blob storage data in the response.
 
@@ -68,7 +68,7 @@ false
 
 #### includeAttestation?
 
-> `optional` **includeAttestation**: `string`
+> `optional` **includeAttestation?**: `string`
 
 Include the attestation information in the response.
 
@@ -80,12 +80,12 @@ false
 
 #### extractRuleGroupId?
 
-> `optional` **extractRuleGroupId**: `string`
+> `optional` **extractRuleGroupId?**: `string`
 
 If provided will extract data from the document using the specified rule group id.
 
 #### extractMimeType?
 
-> `optional` **extractMimeType**: `string`
+> `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

@@ -4,9 +4,9 @@ Response to get a document revision from an auditable item graph vertex.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,7 +16,7 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: [`IDocument`](IDocument.md)
 

package/docs/reference/interfaces/IDocumentManagementQueryRequest.md

@@ -4,9 +4,9 @@ Request to get a list of document from an auditable item graph vertex.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,7 +16,7 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### query
+### query {#query}
 
 > **query**: `object`
 
@@ -30,12 +30,12 @@ The id of the document id we are trying to find.
 
 #### cursor?
 
-> `optional` **cursor**: `string`
+> `optional` **cursor?**: `string`
 
 The cursor to get the next chunk of documents.
 
 #### limit?
 
-> `optional` **limit**: `string`
+> `optional` **limit?**: `string`
 
 The number of documents to return.

package/docs/reference/interfaces/IDocumentManagementQueryResponse.md

@@ -4,9 +4,9 @@ Response to query the documents from an auditable item graph vertex.
 
 ## Properties
 
-### headers?
+### headers? {#headers}
 
-> `optional` **headers**: `object`
+> `optional` **headers?**: `object`
 
 The headers which can be used to determine the response data type.
 
@@ -16,11 +16,11 @@ The headers which can be used to determine the response data type.
 
 #### link?
 
-> `optional` **link**: `string` \| `string`[]
+> `optional` **link?**: `string` \| `string`[]
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `IAuditableItemGraphVertexList`
 

package/docs/reference/interfaces/IDocumentManagementRemoveRequest.md

@@ -4,7 +4,7 @@ Request to remove a document revision from an auditable item graph.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 

package/docs/reference/interfaces/IDocumentManagementUpdateRequest.md

@@ -4,7 +4,7 @@ Request to update a document as an auditable item graph vertex.
 
 ## Properties
 
-### pathParams
+### pathParams {#pathparams}
 
 > **pathParams**: `object`
 
@@ -18,7 +18,7 @@ The full id of the document to get.
 
 ***
 
-### body
+### body {#body}
 
 > **body**: `object`
 
@@ -26,18 +26,18 @@ The body parameters.
 
 #### blob?
 
-> `optional` **blob**: `string`
+> `optional` **blob?**: `string`
 
 The data to create the document with, in base64.
 
 #### annotationObject?
 
-> `optional` **annotationObject**: `IJsonLdNodeObject`
+> `optional` **annotationObject?**: `IJsonLdNodeObject`
 
 Additional information to associate with the document.
 
 #### auditableItemGraphEdges?
 
-> `optional` **auditableItemGraphEdges**: `object`[]
+> `optional` **auditableItemGraphEdges?**: `object`[]
 
 The auditable item graph vertices to connect the document to.

package/docs/reference/variables/DocumentContexts.md

@@ -6,37 +6,37 @@ The contexts of document management objects.
 
 ## Type Declaration
 
-### Namespace
+### Namespace {#namespace}
 
 > `readonly` **Namespace**: `"https://schema.twindev.org/documents/"` = `"https://schema.twindev.org/documents/"`
 
 The canonical RDF namespace URI for Document Management.
 
-### Context
+### Context {#context}
 
 > `readonly` **Context**: `"https://schema.twindev.org/documents/"` = `"https://schema.twindev.org/documents/"`
 
 The value to use in context for Document Management.
 
-### JsonLdContext
+### JsonLdContext {#jsonldcontext}
 
 > `readonly` **JsonLdContext**: `"https://schema.twindev.org/documents/types.jsonld"` = `"https://schema.twindev.org/documents/types.jsonld"`
 
 The JSON-LD Context URL for Document Management.
 
-### NamespaceCommon
+### NamespaceCommon {#namespacecommon}
 
 > `readonly` **NamespaceCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
 
 The canonical RDF namespace URI for TWIN Common.
 
-### ContextCommon
+### ContextCommon {#contextcommon}
 
 > `readonly` **ContextCommon**: `"https://schema.twindev.org/common/"` = `"https://schema.twindev.org/common/"`
 
 The value to use in JSON-LD context for TWIN Common.
 
-### JsonLdContextCommon
+### JsonLdContextCommon {#jsonldcontextcommon}
 
 > `readonly` **JsonLdContextCommon**: `"https://schema.twindev.org/common/types.jsonld"` = `"https://schema.twindev.org/common/types.jsonld"`
 

package/docs/reference/variables/DocumentTypes.md

@@ -6,13 +6,13 @@ The types of document management objects.
 
 ## Type Declaration
 
-### Document
+### Document {#document}
 
 > `readonly` **Document**: `"Document"` = `"Document"`
 
 Represents a document.
 
-### DocumentAttestation
+### DocumentAttestation {#documentattestation}
 
 > `readonly` **DocumentAttestation**: `"DocumentAttestation"` = `"DocumentAttestation"`
 

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/document-management-models",
-	"version": "0.0.3-next.11",
-	"description": "Models which define the structure of the document management connectors and services",
+	"version": "0.0.3-next.13",
+	"description": "Shared data models, schemas, and context definitions for document lifecycle records.",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/document-management.git",
+		"url": "git+https://github.com/iotaledger/document-management.git",
 		"directory": "packages/document-management-models"
 	},
 	"author": "martyn.janes@iota.org",
@@ -56,7 +56,7 @@
 		"schemas"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/document-management/issues"
+		"url": "git+https://github.com/iotaledger/document-management/issues"
 	},
 	"homepage": "https://twindev.org"
 }