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

package/docs/reference/interfaces/IDocumentManagementQueryRequest.md

@@ -0,0 +1,73 @@
+# Interface: IDocumentManagementQueryRequest
+
+Request to get a list of document 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.
+
+#### auditableItemGraphId
+
+> **auditableItemGraphId**: `string`
+
+The id of the auditable item graph vertex which contains the documents.
+
+***
+
+### query?
+
+> `optional` **query**: `object`
+
+The query parameters.
+
+#### documentCodes?
+
+> `optional` **documentCodes**: `string`
+
+List of comma separated document codes to filter the query.
+
+#### includeRemoved?
+
+> `optional` **includeRemoved**: `boolean`
+
+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
+```
+
+#### cursor?
+
+> `optional` **cursor**: `string`
+
+The cursor to get the next chunk of documents.

package/docs/reference/interfaces/IDocumentManagementQueryResponse.md

@@ -0,0 +1,23 @@
+# Interface: IDocumentManagementQueryResponse
+
+Response to query the documents 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**: [`IDocumentList`](IDocumentList.md)
+
+The body parameters.

package/docs/reference/interfaces/IDocumentManagementRemoveRequest.md

@@ -0,0 +1,43 @@
+# Interface: IDocumentManagementRemoveRequest
+
+Request to remove a document from an auditable item graph.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### auditableItemGraphId
+
+> **auditableItemGraphId**: `string`
+
+The id of the auditable item graph vertex to remove the document from.
+
+#### documentId
+
+> **documentId**: `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
+```

package/docs/reference/interfaces/IDocumentManagementSetRequest.md

@@ -0,0 +1,61 @@
+# Interface: IDocumentManagementSetRequest
+
+Request to set a document in 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`
+
+The body parameters.
+
+#### documentId
+
+> **documentId**: `string`
+
+The document id to create.
+
+#### documentIdFormat
+
+> **documentIdFormat**: `undefined` \| `string`
+
+The format of the document identifier.
+
+#### documentCode
+
+> **documentCode**: `string`
+
+The code for the document type.
+
+#### blob
+
+> **blob**: `string`
+
+The data to create the document with, in base64.
+
+#### annotationObject?
+
+> `optional` **annotationObject**: `IJsonLdNodeObject`
+
+Additional information to associate with the document.
+
+#### createAttestation?
+
+> `optional` **createAttestation**: `boolean`
+
+Flag to create an attestation for the document, defaults to false

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

@@ -0,0 +1,31 @@
+# Variable: DocumentTypes
+
+> `const` **DocumentTypes**: `object`
+
+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
+
+> `readonly` **DocumentList**: `"DocumentList"` = `"DocumentList"`
+
+Represents a document list.

package/locales/en.json

@@ -0,0 +1,3 @@
+{
+	"error": {}
+}

package/package.json

@@ -0,0 +1,43 @@
+{
+	"name": "@twin.org/document-management-models",
+	"version": "0.0.1-next.1",
+	"description": "Models which define the structure of the document management connectors and services",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/document-management.git",
+		"directory": "packages/document-management-models"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/attestation-models": "next",
+		"@twin.org/blob-storage-models": "next",
+		"@twin.org/core": "next",
+		"@twin.org/data-json-ld": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/standards-schema-org": "next",
+		"@twin.org/standards-unece": "next"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}