@twin.org/document-management-models 0.0.2-next.4 → 0.0.3-next.2

package/dist/types/models/api/IDocumentManagementGetRevisionRequest.d.ts

@@ -30,17 +30,17 @@ export interface IDocumentManagementGetRevisionRequest {
          * Include the blob storage metadata in the response.
          * @default false
          */
-        includeBlobStorageMetadata?: boolean | string;
+        includeBlobStorageMetadata?: string;
         /**
          * Include the blob storage data in the response.
          * @default false
          */
-        includeBlobStorageData?: boolean | string;
+        includeBlobStorageData?: string;
         /**
          * Include the attestation information in the response.
          * @default false
          */
-        includeAttestation?: boolean | string;
+        includeAttestation?: string;
         /**
          * If provided will extract data from the document using the specified rule group id.
          */

package/dist/types/models/api/IDocumentManagementGetRevisionResponse.d.ts

@@ -1,5 +1,5 @@
 import type { HeaderTypes, MimeTypes } from "@twin.org/web";
-import type { IDocument } from "../IDocument";
+import type { IDocument } from "../IDocument.js";
 /**
  * Response to get a document revision from an auditable item graph vertex.
  */

package/docs/changelog.md

@@ -1,5 +1,36 @@
 # @twin.org/document-management-models - Changelog
 
+## [0.0.3-next.2](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.3-next.1...document-management-models-v0.0.3-next.2) (2025-11-28)
+
+
+### Features
+
+* update background task service ([5c380dc](https://github.com/twinfoundation/document-management/commit/5c380dca3114254201768f184f9486828501ff66))
+
+## [0.0.3-next.1](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.3-next.0...document-management-models-v0.0.3-next.1) (2025-11-12)
+
+
+### Features
+
+* add context id features ([#24](https://github.com/twinfoundation/document-management/issues/24)) ([83f65f1](https://github.com/twinfoundation/document-management/commit/83f65f15e55f2293f5ca0d9d1e4679ba67c4ec8d))
+* add validate-locales ([b6b6f9e](https://github.com/twinfoundation/document-management/commit/b6b6f9e9d66c17af3d030247ca168ac0b5844bdc))
+* data type registration use fully qualified names ([18d27d0](https://github.com/twinfoundation/document-management/commit/18d27d0c21d0f652b7df4b409bb2d3c66cf22f84))
+* document get can perform extraction ([#6](https://github.com/twinfoundation/document-management/issues/6)) ([5ce6d37](https://github.com/twinfoundation/document-management/commit/5ce6d37432ad271ca5783f422846f4be98ec2215))
+* eslint migration to flat config ([98635aa](https://github.com/twinfoundation/document-management/commit/98635aa24ebafba265e989e461fe98104f683191))
+* get document revision ([080eddc](https://github.com/twinfoundation/document-management/commit/080eddcc024c622dda6bb36f60f5fa80a86cf5bb))
+* improve comments ([4d2f094](https://github.com/twinfoundation/document-management/commit/4d2f094b23e3320cb739917246c1ee5f6ad41c11))
+* store document as a vertex ([#2](https://github.com/twinfoundation/document-management/issues/2)) ([7febedc](https://github.com/twinfoundation/document-management/commit/7febedc3fb31de9c19565d6326341046834f2c74))
+* update dependencies ([f9d8641](https://github.com/twinfoundation/document-management/commit/f9d86417dba24027699225ec7473296e361dcb00))
+* update framework core ([f991a59](https://github.com/twinfoundation/document-management/commit/f991a59d25ec228bcdd7a5b6bd55578985b55a84))
+* update ts-to-schema generation ([01a5335](https://github.com/twinfoundation/document-management/commit/01a5335372f6a4764a74d56c446d669724a308aa))
+* use standard list json ld types ([20ea04b](https://github.com/twinfoundation/document-management/commit/20ea04b05fd4bc4fcedce8f66958942c3c2fa303))
+* use targetId in AIG for edges ([82dec81](https://github.com/twinfoundation/document-management/commit/82dec8190d8b523b350ef133bdcf648cab1023b0))
+
+
+### Bug Fixes
+
+* query params force coercion ([d667d0f](https://github.com/twinfoundation/document-management/commit/d667d0f195accca2887a5ca732e9790063763996))
+
 ## [0.0.2-next.4](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.2-next.3...document-management-models-v0.0.2-next.4) (2025-10-09)
 
 

package/docs/reference/interfaces/IDocument.md

@@ -140,16 +140,16 @@ The date/time of when the document was deleted, as we never actually remove item
 
 ***
 
-### nodeIdentity
+### organizationIdentity?
 
-> **nodeIdentity**: `string`
+> `optional` **organizationIdentity**: `string`
 
-The node which added the document to the graph.
+The organization which added the document to the graph.
 
 ***
 
-### userIdentity
+### userIdentity?
 
-> **userIdentity**: `string`
+> `optional` **userIdentity**: `string`
 
 The user who added the document to the graph.

package/docs/reference/interfaces/IDocumentManagementComponent.md

@@ -6,19 +6,11 @@ Interface describing an document management contract.
 
 - `IComponent`
 
-## Indexable
-
-\[`key`: `string`\]: `any`
-
-All methods are optional, so we introduce an index signature to allow
-any additional properties or methods, which removes the TypeScript error where
-the class has no properties in common with the type.
-
 ## Methods
 
 ### create()
 
-> **create**(`documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject?`, `auditableItemGraphEdges?`, `options?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`string`\>
+> **create**(`documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject?`, `auditableItemGraphEdges?`, `options?`): `Promise`\<`string`\>
 
 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.
@@ -36,7 +28,7 @@ The document id to create.
 
 The format of the document identifier.
 
-`undefined` | `string`
+`string` | `undefined`
 
 ##### documentCode
 
@@ -84,18 +76,6 @@ Flag to add the document id as an alias to the aig vertex, defaults to true.
 
 Annotation object for the alias.
 
-##### userIdentity?
-
-`string`
-
-The identity to perform the auditable item graph operation with.
-
-##### nodeIdentity?
-
-`string`
-
-The node identity to use for vault operations.
-
 #### Returns
 
 `Promise`\<`string`\>
@@ -106,7 +86,7 @@ The auditable item graph vertex created for the document including its revision.
 
 ### update()
 
-> **update**(`auditableItemGraphDocumentId`, `blob?`, `annotationObject?`, `auditableItemGraphEdges?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
+> **update**(`auditableItemGraphDocumentId`, `blob?`, `annotationObject?`, `auditableItemGraphEdges?`): `Promise`\<`void`\>
 
 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.
@@ -138,18 +118,6 @@ Additional information to associate with the document.
 
 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 node identity to use for vault operations.
-
 #### Returns
 
 `Promise`\<`void`\>
@@ -160,7 +128,7 @@ Nothing.
 
 ### get()
 
-> **get**(`auditableItemGraphDocumentId`, `options?`, `cursor?`, `limit?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<[`IDocumentList`](IDocumentList.md)\>
+> **get**(`auditableItemGraphDocumentId`, `options?`, `cursor?`, `limit?`): `Promise`\<[`IDocumentList`](IDocumentList.md)\>
 
 Get a document using it's auditable item graph vertex id and optional revision.
 
@@ -224,18 +192,6 @@ The cursor to get the next chunk of revisions.
 
 Limit the number of items to return, defaults to 1 so only most recent is returned.
 
-##### userIdentity?
-
-`string`
-
-The identity to perform the auditable item graph operation with.
-
-##### nodeIdentity?
-
-`string`
-
-The node identity to use for vault operations.
-
 #### Returns
 
 `Promise`\<[`IDocumentList`](IDocumentList.md)\>
@@ -246,7 +202,7 @@ The documents and revisions if requested, ordered by revision descending, cursor
 
 ### getRevision()
 
-> **getRevision**(`auditableItemGraphDocumentId`, `revision`, `options?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<[`IDocument`](IDocument.md)\>
+> **getRevision**(`auditableItemGraphDocumentId`, `revision`, `options?`): `Promise`\<[`IDocument`](IDocument.md)\>
 
 Get a document revision using it's auditable item graph vertex id.
 
@@ -298,18 +254,6 @@ If provided will extract data from the document using the specified rule group i
 
 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`](IDocument.md)\>
@@ -320,7 +264,7 @@ The documents and revisions if requested, ordered by revision descending, cursor
 
 ### removeRevision()
 
-> **removeRevision**(`auditableItemGraphDocumentId`, `revision`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
+> **removeRevision**(`auditableItemGraphDocumentId`, `revision`): `Promise`\<`void`\>
 
 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.
@@ -339,18 +283,6 @@ The auditable item graph vertex id which contains the document.
 
 The revision of the document to remove.
 
-##### userIdentity?
-
-`string`
-
-The identity to perform the auditable item graph operation with.
-
-##### nodeIdentity?
-
-`string`
-
-The node identity to use for vault operations.
-
 #### Returns
 
 `Promise`\<`void`\>
@@ -361,7 +293,7 @@ Nothing.
 
 ### query()
 
-> **query**(`documentId`, `cursor?`, `limit?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`IAuditableItemGraphVertexList`\>
+> **query**(`documentId`, `cursor?`, `limit?`): `Promise`\<`IAuditableItemGraphVertexList`\>
 
 Find all the document with a specific id.
 
@@ -385,18 +317,6 @@ The cursor to get the next chunk of documents.
 
 The limit to get the next chunk of documents.
 
-##### userIdentity?
-
-`string`
-
-The identity to perform the auditable item graph operation with.
-
-##### nodeIdentity?
-
-`string`
-
-The node identity to use for vault operations.
-
 #### Returns
 
 `Promise`\<`IAuditableItemGraphVertexList`\>

package/docs/reference/interfaces/IDocumentManagementCreateRequest.md

@@ -18,7 +18,7 @@ The document id to create.
 
 #### documentIdFormat
 
-> **documentIdFormat**: `undefined` \| `string`
+> **documentIdFormat**: `string` \| `undefined`
 
 The format of the document identifier.
 

package/docs/reference/interfaces/IDocumentManagementGetRequest.md

@@ -38,7 +38,7 @@ The query parameters.
 
 #### includeBlobStorageMetadata?
 
-> `optional` **includeBlobStorageMetadata**: `string` \| `boolean`
+> `optional` **includeBlobStorageMetadata**: `string`
 
 Include the blob storage metadata in the response.
 
@@ -50,7 +50,7 @@ false
 
 #### includeBlobStorageData?
 
-> `optional` **includeBlobStorageData**: `string` \| `boolean`
+> `optional` **includeBlobStorageData**: `string`
 
 Include the blob storage data in the response.
 
@@ -62,7 +62,7 @@ false
 
 #### includeAttestation?
 
-> `optional` **includeAttestation**: `string` \| `boolean`
+> `optional` **includeAttestation**: `string`
 
 Include the attestation information in the response.
 
@@ -74,7 +74,7 @@ false
 
 #### includeRemoved?
 
-> `optional` **includeRemoved**: `string` \| `boolean`
+> `optional` **includeRemoved**: `string`
 
 Include deleted documents in the response.
 

package/docs/reference/interfaces/IDocumentManagementGetRevisionRequest.md

@@ -44,7 +44,7 @@ The query parameters.
 
 #### includeBlobStorageMetadata?
 
-> `optional` **includeBlobStorageMetadata**: `string` \| `boolean`
+> `optional` **includeBlobStorageMetadata**: `string`
 
 Include the blob storage metadata in the response.
 
@@ -56,7 +56,7 @@ false
 
 #### includeBlobStorageData?
 
-> `optional` **includeBlobStorageData**: `string` \| `boolean`
+> `optional` **includeBlobStorageData**: `string`
 
 Include the blob storage data in the response.
 
@@ -68,7 +68,7 @@ false
 
 #### includeAttestation?
 
-> `optional` **includeAttestation**: `string` \| `boolean`
+> `optional` **includeAttestation**: `string`
 
 Include the attestation information in the response.
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/document-management-models",
-	"version": "0.0.2-next.4",
+	"version": "0.0.3-next.2",
 	"description": "Models which define the structure of the document management connectors and services",
 	"repository": {
 		"type": "git",
@@ -24,20 +24,18 @@
 		"@twin.org/standards-schema-org": "next",
 		"@twin.org/standards-unece": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"

package/dist/cjs/index.cjs

@@ -1,190 +0,0 @@
-'use strict';
-
-var dataCore = require('@twin.org/data-core');
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The contexts of document management objects.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const DocumentContexts = {
-    /**
-     * The context root for the document types.
-     */
-    ContextRoot: "https://schema.twindev.org/documents/",
-    /**
-     * The context root for the common types.
-     */
-    ContextRootCommon: "https://schema.twindev.org/common/"
-};
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * The types of document management objects.
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const DocumentTypes = {
-    /**
-     * Represents a document.
-     */
-    Document: "Document",
-    /**
-     * Represents a document attestation.
-     */
-    DocumentAttestation: "DocumentAttestation"
-};
-
-var $schema = "https://json-schema.org/draft/2020-12/schema";
-var $id = "https://schema.twindev.org/documents/Document";
-var description = "Interface describing a document.";
-var type = "object";
-var properties = {
-	"@context": {
-		type: "array",
-		minItems: 3,
-		items: {
-			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
-		},
-		description: "JSON-LD Context.",
-		prefixItems: [
-			{
-				type: "string",
-				"const": "https://schema.twindev.org/documents/"
-			},
-			{
-				type: "string",
-				"const": "https://schema.twindev.org/common/"
-			},
-			{
-				type: "string",
-				"const": "https://schema.org"
-			}
-		]
-	},
-	type: {
-		type: "string",
-		"const": "Document",
-		description: "JSON-LD Type."
-	},
-	id: {
-		type: "string",
-		description: "The full id of the document."
-	},
-	documentId: {
-		type: "string",
-		description: "The id of the document."
-	},
-	documentIdFormat: {
-		type: "string",
-		description: "The format of the document id."
-	},
-	documentCode: {
-		$ref: "https://vocabulary.uncefact.org/DocumentCodeList",
-		description: "The code for the document type."
-	},
-	documentRevision: {
-		type: "number",
-		description: "The revision of the document as a 0 based index."
-	},
-	annotationObject: {
-		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
-		description: "Additional annotation information for the document."
-	},
-	blobStorageId: {
-		type: "string",
-		description: "The blob storage id for the document."
-	},
-	blobHash: {
-		type: "string",
-		description: "The hash of the blob data."
-	},
-	blobStorageEntry: {
-		$ref: "https://schema.twindev.org/blob-storage/BlobStorageEntry",
-		description: "The additional JSON-LD for blob storage if it was requested."
-	},
-	extractedData: {
-		description: "The data extracted from the document using data extraction services."
-	},
-	attestationId: {
-		type: "string",
-		description: "The attestation for the document if one was created."
-	},
-	attestationInformation: {
-		$ref: "https://schema.twindev.org/attestation/AttestationInformation",
-		description: "The additional JSON-LD for attestation storage if it was requested."
-	},
-	dateCreated: {
-		type: "string",
-		description: "The date/time of when the document was created."
-	},
-	dateModified: {
-		type: "string",
-		description: "The date/time of when the document was modified."
-	},
-	dateDeleted: {
-		type: "string",
-		description: "The date/time of when the document was deleted, as we never actually remove items."
-	},
-	nodeIdentity: {
-		type: "string",
-		description: "The node which added the document to the graph."
-	},
-	userIdentity: {
-		type: "string",
-		description: "The user who added the document to the graph."
-	}
-};
-var required = [
-	"@context",
-	"type",
-	"id",
-	"documentId",
-	"documentCode",
-	"documentRevision",
-	"blobStorageId",
-	"blobHash",
-	"dateCreated",
-	"nodeIdentity",
-	"userIdentity"
-];
-var additionalProperties = false;
-var DocumentSchema = {
-	$schema: $schema,
-	$id: $id,
-	description: description,
-	type: type,
-	properties: properties,
-	required: required,
-	additionalProperties: additionalProperties
-};
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Handle all the data types for document management.
- */
-class DocumentManagementDataTypes {
-    /**
-     * Register all the data types.
-     */
-    static registerTypes() {
-        dataCore.DataTypeHandlerFactory.register(`${DocumentContexts.ContextRoot}${DocumentTypes.Document}`, () => ({
-            context: DocumentContexts.ContextRoot,
-            type: DocumentTypes.Document,
-            defaultValue: {},
-            jsonSchema: async () => DocumentSchema
-        }));
-        dataCore.DataTypeHandlerFactory.register(`${DocumentContexts.ContextRoot}${DocumentTypes.DocumentAttestation}`, () => ({
-            context: DocumentContexts.ContextRoot,
-            type: DocumentTypes.DocumentAttestation,
-            defaultValue: {},
-            jsonSchema: async () => DocumentSchema
-        }));
-    }
-}
-
-exports.DocumentContexts = DocumentContexts;
-exports.DocumentManagementDataTypes = DocumentManagementDataTypes;
-exports.DocumentTypes = DocumentTypes;