@twin.org/document-management-service 0.0.1-next.9 → 0.0.1

package/docs/reference/classes/DocumentManagementService.md

@@ -240,6 +240,18 @@ Flag to include the attestation information for the document, defaults to false.
 
 Flag to include deleted documents, defaults to false.
 
+###### extractRuleGroupId?
+
+`string`
+
+If provided will extract data from the document using the specified rule group id.
+
+###### extractMimeType?
+
+`string`
+
+By default extraction will auto detect the mime type of the document, this can be used to override the detection.
+
 ##### cursor?
 
 `string`
@@ -276,6 +288,84 @@ The documents and revisions if requested, ordered by revision descending, cursor
 
 ***
 
+### getRevision()
+
+> **getRevision**(`auditableItemGraphDocumentId`, `revision`, `options?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`IDocument`\>
+
+Get a document revision using it's auditable item graph vertex id.
+
+#### Parameters
+
+##### auditableItemGraphDocumentId
+
+`string`
+
+The auditable item graph vertex id which contains the document.
+
+##### revision
+
+`number`
+
+The revision id for the document.
+
+##### options?
+
+Additional options for the get operation.
+
+###### includeBlobStorageMetadata?
+
+`boolean`
+
+Flag to include the blob storage metadata for the document, defaults to false.
+
+###### includeBlobStorageData?
+
+`boolean`
+
+Flag to include the blob storage data for the document, defaults to false.
+
+###### includeAttestation?
+
+`boolean`
+
+Flag to include the attestation information for the document, defaults to false.
+
+###### extractRuleGroupId?
+
+`string`
+
+If provided will extract data from the document using the specified rule group id.
+
+###### extractMimeType?
+
+`string`
+
+By default extraction will auto detect the mime type of the document, this can be used to override the detection.
+
+##### userIdentity?
+
+`string`
+
+The identity to perform the auditable item graph operation with.
+
+##### nodeIdentity?
+
+`string`
+
+The node identity to use for vault operations.
+
+#### Returns
+
+`Promise`\<`IDocument`\>
+
+The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
+
+#### Implementation of
+
+`IDocumentManagementComponent.getRevision`
+
+***
+
 ### removeRevision()
 
 > **removeRevision**(`auditableItemGraphDocumentId`, `revision`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>

package/docs/reference/functions/documentManagementGetRevision.md

@@ -0,0 +1,31 @@
+# Function: documentManagementGetRevision()
+
+> **documentManagementGetRevision**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`IDocumentManagementGetRevisionResponse`\>
+
+Get the document revision from the auditable item graph vertex.
+
+## Parameters
+
+### httpRequestContext
+
+`IHttpRequestContext`
+
+The request context for the API.
+
+### componentName
+
+`string`
+
+The name of the component to use in the routes.
+
+### request
+
+`IDocumentManagementGetRevisionRequest`
+
+The request.
+
+## Returns
+
+`Promise`\<`IDocumentManagementGetRevisionResponse`\>
+
+The response object with additional http response properties.

package/docs/reference/functions/documentManagementUpdate.md

@@ -2,7 +2,7 @@
 
 > **documentManagementUpdate**(`httpRequestContext`, `componentName`, `request`): `Promise`\<`INoContentResponse`\>
 
-UPdate the document from the auditable item graph vertex.
+Update the document from the auditable item graph vertex.
 
 ## Parameters
 

package/docs/reference/index.md

@@ -19,6 +19,7 @@
 - [generateRestRoutesDocumentManagement](functions/generateRestRoutesDocumentManagement.md)
 - [documentManagementCreate](functions/documentManagementCreate.md)
 - [documentManagementGet](functions/documentManagementGet.md)
+- [documentManagementGetRevision](functions/documentManagementGetRevision.md)
 - [documentManagementUpdate](functions/documentManagementUpdate.md)
 - [documentManagementRemove](functions/documentManagementRemove.md)
 - [documentManagementQuery](functions/documentManagementQuery.md)

package/docs/reference/interfaces/IDocumentManagementServiceConstructorOptions.md

@@ -46,6 +46,20 @@ attestation
 
 ***
 
+### dataProcessingComponentType?
+
+> `optional` **dataProcessingComponentType**: `string`
+
+The type of the data processing component.
+
+#### Default
+
+```ts
+data-processing
+```
+
+***
+
 ### config?
 
 > `optional` **config**: [`IDocumentManagementServiceConfig`](IDocumentManagementServiceConfig.md)

package/locales/en.json

@@ -4,10 +4,11 @@
 			"createFailed": "Failed to create document",
 			"updateFailed": "Failed to update document",
 			"getFailed": "Failed to get document",
+			"getRevisionFailed": "Failed to get document revision",
 			"removeRevision": "Failed to remove document revision",
 			"queryFailed": "Failed to query document",
 			"documentRevisionNone": "There are no revisions in the document",
-			"documentRevisionNotFound": "There is no revision number \"{revision}\" in the document",
+			"documentRevisionNotFound": "There is no revision number \"{notFoundId}\" in the document",
 			"namespaceMismatch": "The namespace in the urn \"{id}\" does not match the namespace of the Document Management component \"{namespace}\""
 		}
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/document-management-service",
-	"version": "0.0.1-next.9",
+	"version": "0.0.1",
 	"description": "Document management contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -13,21 +13,79 @@
 	"engines": {
 		"node": ">=20.0.0"
 	},
+	"scripts": {
+		"clean": "rimraf dist coverage docs/reference",
+		"build": "tsc",
+		"dev": "nodemon --watch src --ext ts --exec \"npm run build && npm run bundle:esm\"",
+		"test": "vitest --run --config ./vitest.config.ts --no-cache",
+		"coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
+		"bundle:esm": "rollup --config rollup.config.mjs --environment MODULE:esm",
+		"bundle:cjs": "rollup --config rollup.config.mjs --environment MODULE:cjs",
+		"bundle": "npm run bundle:esm && npm run bundle:cjs",
+		"docs:clean": "rimraf docs/reference",
+		"docs:generate": "typedoc",
+		"docs:api": "ts-to-openapi ./ts-to-openapi.json ./docs/open-api/spec.json",
+		"docs": "npm run docs:clean && npm run docs:generate && npm run docs:api",
+		"dist": "npm run clean && npm run build && npm run test && npm run bundle && npm run docs",
+		"dist:no-test": "npm run clean && npm run build && npm run bundle && npm run docs",
+		"prepare": "ts-patch install -s"
+	},
 	"dependencies": {
-		"@twin.org/api-models": "next",
-		"@twin.org/attestation-models": "next",
-		"@twin.org/auditable-item-graph-models": "next",
-		"@twin.org/blob-storage-models": "next",
-		"@twin.org/core": "next",
-		"@twin.org/crypto": "next",
-		"@twin.org/data-json-ld": "next",
-		"@twin.org/document-management-models": "0.0.1-next.9",
-		"@twin.org/entity": "next",
-		"@twin.org/entity-storage-models": "next",
-		"@twin.org/nameof": "next",
-		"@twin.org/standards-schema-org": "next",
-		"@twin.org/standards-unece": "next",
-		"@twin.org/web": "next"
+		"@twin.org/api-models": "^0.0.2-next.1",
+		"@twin.org/attestation-models": "^0.0.1",
+		"@twin.org/auditable-item-graph-models": "^0.0.1",
+		"@twin.org/blob-storage-models": "^0.0.1",
+		"@twin.org/data-processing-models": "^0.0.1",
+		"@twin.org/document-management-models": "^0.0.1",
+		"@twin.org/core": "^0.0.1",
+		"@twin.org/crypto": "^0.0.1",
+		"@twin.org/data-json-ld": "^0.0.1",
+		"@twin.org/entity": "^0.0.1",
+		"@twin.org/entity-storage-models": "^0.0.1",
+		"@twin.org/nameof": "^0.0.1",
+		"@twin.org/standards-schema-org": "^0.0.1",
+		"@twin.org/standards-unece": "^0.0.1",
+		"@twin.org/web": "^0.0.1"
+	},
+	"devDependencies": {
+		"@twin.org/attestation-connector-nft": "^0.0.1",
+		"@twin.org/attestation-service": "^0.0.1",
+		"@twin.org/auditable-item-graph-service": "^0.0.1",
+		"@twin.org/background-task-models": "^0.0.2-next.2",
+		"@twin.org/background-task-connector-entity-storage": "^0.0.2-next.2",
+		"@twin.org/blob-storage-connector-memory": "^0.0.1",
+		"@twin.org/blob-storage-service": "^0.0.1",
+		"@twin.org/data-processing-converters": "^0.0.1",
+		"@twin.org/data-processing-extractors": "^0.0.1",
+		"@twin.org/data-processing-service": "^0.0.1",
+		"@twin.org/entity-storage-connector-memory": "^0.0.1",
+		"@twin.org/identity-connector-entity-storage": "^0.0.1",
+		"@twin.org/identity-models": "^0.0.1",
+		"@twin.org/immutable-proof-models": "^0.0.1",
+		"@twin.org/immutable-proof-service": "^0.0.1",
+		"@twin.org/modules": "^0.0.1",
+		"@twin.org/nft-connector-entity-storage": "^0.0.1",
+		"@twin.org/nft-models": "^0.0.1",
+		"@twin.org/nameof-transformer": "^0.0.1",
+		"@twin.org/nameof-vitest-plugin": "^0.0.1",
+		"@twin.org/ts-to-openapi": "^0.0.1",
+		"@twin.org/vault-models": "^0.0.1",
+		"@twin.org/vault-connector-entity-storage": "^0.0.1",
+		"@twin.org/verifiable-storage-models": "^0.0.1",
+		"@twin.org/verifiable-storage-connector-entity-storage": "^0.0.1",
+		"@twin.org/wallet-models": "^0.0.1",
+		"@twin.org/wallet-connector-entity-storage": "^0.0.1",
+		"@types/node": "24.0.1",
+		"@vitest/coverage-v8": "3.2.3",
+		"copyfiles": "2.4.1",
+		"nodemon": "3.1.10",
+		"rimraf": "6.0.1",
+		"rollup": "4.43.0",
+		"ts-patch": "3.3.0",
+		"typedoc": "0.28.5",
+		"typedoc-plugin-markdown": "4.6.4",
+		"typescript": "5.8.3",
+		"vitest": "3.2.3"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",