@twin.org/document-management-models 0.0.1-next.2 → 0.0.1-next.20

package/dist/types/models/IDocumentManagementComponent.d.ts

@@ -1,3 +1,4 @@
+import type { IAuditableItemGraphVertexList } from "@twin.org/auditable-item-graph-models";
 import type { IComponent } from "@twin.org/core";
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { UneceDocumentCodes } from "@twin.org/standards-unece";
@@ -8,71 +9,112 @@ import type { IDocumentList } from "./IDocumentList";
  */
 export interface IDocumentManagementComponent extends IComponent {
     /**
-     * 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.
-     * @param auditableItemGraphId The auditable item graph vertex id to create the document on.
      * @param documentId The document id to create.
      * @param documentIdFormat The format of the document identifier.
      * @param documentCode The code for the document type.
      * @param blob The data to create the document with.
      * @param annotationObject Additional information to associate with the document.
-     * @param createAttestation Flag to create an attestation for the document, defaults to false.
+     * @param auditableItemGraphEdges The auditable item graph vertices to connect the document to.
+     * @param options Additional options for the set operation.
+     * @param options.createAttestation Flag to create an attestation for the document, defaults to false.
+     * @param options.addAlias Flag to add the document id as an alias to the aig vertex, defaults to true.
+     * @param options.aliasAnnotationObject Annotation object for the alias.
      * @param userIdentity The identity to perform the auditable item graph operation with.
      * @param nodeIdentity The node identity to use for vault operations.
-     * @returns The identifier for the document which includes the auditable item graph identifier.
+     * @returns The auditable item graph vertex created for the document including its revision.
      */
-    set(auditableItemGraphId: string, documentId: string, documentIdFormat: string | undefined, documentCode: UneceDocumentCodes, blob: Uint8Array, annotationObject?: IJsonLdNodeObject, createAttestation?: boolean, userIdentity?: string, nodeIdentity?: string): Promise<string>;
+    create(documentId: string, documentIdFormat: string | undefined, documentCode: UneceDocumentCodes, blob: Uint8Array, annotationObject?: IJsonLdNodeObject, auditableItemGraphEdges?: {
+        id: string;
+        addAlias?: boolean;
+        aliasAnnotationObject?: IJsonLdNodeObject;
+    }[], options?: {
+        createAttestation?: boolean;
+        addAlias?: boolean;
+        aliasAnnotationObject?: IJsonLdNodeObject;
+    }, userIdentity?: string, nodeIdentity?: string): Promise<string>;
     /**
-     * Get a specific document from an auditable item graph vertex.
-     * @param auditableItemGraphId The auditable item graph vertex id to get the document from.
-     * @param identifier The identifier of the document to get.
+     * 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.
+     * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
+     * @param blob The data to update the document with.
+     * @param annotationObject Additional information to associate with the document.
+     * @param auditableItemGraphEdges The auditable item graph vertices to connect the document to, if undefined retains current connections.
+     * @param userIdentity The identity to perform the auditable item graph operation with.
+     * @param nodeIdentity The node identity to use for vault operations.
+     * @returns Nothing.
+     */
+    update(auditableItemGraphDocumentId: string, blob?: Uint8Array, annotationObject?: IJsonLdNodeObject, auditableItemGraphEdges?: {
+        id: string;
+        addAlias?: boolean;
+        aliasAnnotationObject?: IJsonLdNodeObject;
+    }[], userIdentity?: string, nodeIdentity?: string): Promise<void>;
+    /**
+     * Get a document using it's auditable item graph vertex id and optional revision.
+     * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
      * @param options Additional options for the get operation.
      * @param options.includeBlobStorageMetadata Flag to include the blob storage metadata for the document, defaults to false.
      * @param options.includeBlobStorageData Flag to include the blob storage data for the document, defaults to false.
      * @param options.includeAttestation Flag to include the attestation information for the document, defaults to false.
      * @param options.includeRemoved Flag to include deleted documents, defaults to false.
-     * @param options.maxRevisionCount Max number of revisions to return, defaults to 0.
-     * @param revisionCursor The cursor to get the next chunk of revisions.
+     * @param options.extractRuleGroupId If provided will extract data from the document using the specified rule group id.
+     * @param options.extractMimeType By default extraction will auto detect the mime type of the document, this can be used to override the detection.
+     * @param cursor The cursor to get the next chunk of revisions.
+     * @param pageSize Page size of items to return, defaults to 1 so only most recent is returned.
      * @param userIdentity The identity to perform the auditable item graph operation with.
      * @param nodeIdentity The node identity to use for vault operations.
      * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
      */
-    get(auditableItemGraphId: string, identifier: string, options?: {
+    get(auditableItemGraphDocumentId: string, options?: {
         includeBlobStorageMetadata?: boolean;
         includeBlobStorageData?: boolean;
         includeAttestation?: boolean;
         includeRemoved?: boolean;
-        maxRevisionCount?: number;
-    }, revisionCursor?: string, userIdentity?: string, nodeIdentity?: string): Promise<IDocument>;
+        extractRuleGroupId?: string;
+        extractMimeType?: string;
+    }, cursor?: string, pageSize?: number, userIdentity?: string, nodeIdentity?: string): Promise<IDocumentList>;
     /**
-     * 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.
-     * @param auditableItemGraphId The auditable item graph vertex id to remove the document from.
-     * @param identifier The identifier of the document to remove.
-     * @param options Additional options for the remove operation.
-     * @param options.removeAllRevisions Flag to remove all revisions of the document, defaults to false.
+     * Get a document revision using it's auditable item graph vertex id.
+     * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
+     * @param revision The revision id of the document to get.
+     * @param options Additional options for the get operation.
+     * @param options.includeBlobStorageMetadata Flag to include the blob storage metadata for the document, defaults to false.
+     * @param options.includeBlobStorageData Flag to include the blob storage data for the document, defaults to false.
+     * @param options.includeAttestation Flag to include the attestation information for the document, defaults to false.
+     * @param options.extractRuleGroupId If provided will extract data from the document using the specified rule group id.
+     * @param options.extractMimeType By default extraction will auto detect the mime type of the document, this can be used to override the detection.
+     * @param userIdentity The identity to perform the auditable item graph operation with.
+     * @param nodeIdentity The node identity to use for vault operations.
+     * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
+     */
+    getRevision(auditableItemGraphDocumentId: string, revision: number, options?: {
+        includeBlobStorageMetadata?: boolean;
+        includeBlobStorageData?: boolean;
+        includeAttestation?: boolean;
+        extractRuleGroupId?: string;
+        extractMimeType?: string;
+    }, userIdentity?: string, nodeIdentity?: string): Promise<IDocument>;
+    /**
+     * 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.
+     * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
+     * @param revision The revision of the document to remove.
      * @param userIdentity The identity to perform the auditable item graph operation with.
      * @param nodeIdentity The node identity to use for vault operations.
      * @returns Nothing.
      */
-    remove(auditableItemGraphId: string, identifier: string, options?: {
-        removeAllRevisions?: boolean;
-    }, userIdentity?: string, nodeIdentity?: string): Promise<void>;
+    removeRevision(auditableItemGraphDocumentId: string, revision: number, userIdentity?: string, nodeIdentity?: string): Promise<void>;
     /**
-     * Query an auditable item graph vertex for documents.
-     * @param auditableItemGraphId The auditable item graph vertex to get the documents from.
-     * @param documentCodes The document codes to query for, if undefined gets all document codes.
-     * @param options Additional options for the query operation.
-     * @param options.includeMostRecentRevisions Include the most recent 5 revisions, use the individual get to retrieve more.
-     * @param options.includeRemoved Flag to include deleted documents, defaults to false.
+     * Find all the document with a specific id.
+     * @param documentId The document id to find in the graph.
      * @param cursor The cursor to get the next chunk of documents.
+     * @param pageSize The page size to get the next chunk of documents.
      * @param userIdentity The identity to perform the auditable item graph operation with.
      * @param nodeIdentity The node identity to use for vault operations.
-     * @returns The most recent revisions of each document, cursor is set if there are more documents.
+     * @returns The graph vertices that contain documents referencing the specified document id.
      */
-    query(auditableItemGraphId: string, documentCodes?: UneceDocumentCodes[], options?: {
-        includeMostRecentRevisions?: boolean;
-        includeRemoved?: boolean;
-    }, cursor?: string, userIdentity?: string, nodeIdentity?: string): Promise<IDocumentList>;
+    query(documentId: string, cursor?: string, pageSize?: number, userIdentity?: string, nodeIdentity?: string): Promise<IAuditableItemGraphVertexList>;
 }

package/dist/types/models/api/{IDocumentManagementSetRequest.d.ts → IDocumentManagementCreateRequest.d.ts}

@@ -1,18 +1,9 @@
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { UneceDocumentCodes } from "@twin.org/standards-unece";
 /**
- * Request to set a document in an auditable item graph vertex.
+ * Request to create a document as an auditable item graph vertex.
  */
-export interface IDocumentManagementSetRequest {
-    /**
-     * The path parameters.
-     */
-    pathParams: {
-        /**
-         * The id of the auditable item graph vertex to store the document on.
-         */
-        auditableItemGraphId: string;
-    };
+export interface IDocumentManagementCreateRequest {
     /**
      * The body parameters.
      */
@@ -38,8 +29,24 @@ export interface IDocumentManagementSetRequest {
          */
         annotationObject?: IJsonLdNodeObject;
         /**
-         * Flag to create an attestation for the document, defaults to false
+         * The auditable item graph vertices to connect the document to.
+         */
+        auditableItemGraphEdges?: {
+            id: string;
+            addAlias?: boolean;
+            aliasAnnotationObject?: IJsonLdNodeObject;
+        }[];
+        /**
+         * Flag to create an attestation for the document, defaults to false.
          */
         createAttestation?: boolean;
+        /**
+         * Flag to add the document id as an alias to the aig vertex, defaults to true.
+         */
+        addAlias?: boolean;
+        /**
+         * Annotation object for the alias.
+         */
+        aliasAnnotationObject?: IJsonLdNodeObject;
     };
 }

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

@@ -13,14 +13,10 @@ export interface IDocumentManagementGetRequest {
      * The path parameters.
      */
     pathParams: {
-        /**
-         * The id of the auditable item graph vertex to store the document on.
-         */
-        auditableItemGraphId: string;
         /**
          * The full id of the document to get.
          */
-        documentId: string;
+        auditableItemGraphDocumentId: string;
     };
     /**
      * The query parameters.
@@ -30,30 +26,38 @@ export interface IDocumentManagementGetRequest {
          * Include the blob storage metadata in the response.
          * @default false
          */
-        includeBlobStorageMetadata?: boolean;
+        includeBlobStorageMetadata?: boolean | string;
         /**
          * Include the blob storage data in the response.
          * @default false
          */
-        includeBlobStorageData?: boolean;
+        includeBlobStorageData?: boolean | string;
         /**
          * Include the attestation information in the response.
          * @default false
          */
-        includeAttestation?: boolean;
+        includeAttestation?: boolean | string;
         /**
          * Include deleted documents in the response.
          * @default false
          */
-        includeRemoved?: boolean;
+        includeRemoved?: boolean | string;
+        /**
+         * If provided will extract data from the document using the specified rule group id.
+         */
+        extractRuleGroupId?: string;
+        /**
+         * By default extraction will auto detect the mime type of the document, this can be used to override the detection.
+         */
+        extractMimeType?: string;
         /**
-         * Max number of revisions to return.
-         * @default 0
+         * Page size of items to return, defaults to 1 so only most recent is returned.
+         * @default 1
          */
-        maxRevisionCount?: number;
+        pageSize?: number | string;
         /**
          * The cursor to get the next chunk of revisions.
          */
-        revisionCursor?: string;
+        cursor?: string;
     };
 }

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

@@ -1,5 +1,5 @@
 import type { HeaderTypes, MimeTypes } from "@twin.org/web";
-import type { IDocument } from "../IDocument";
+import type { IDocumentList } from "../IDocumentList";
 /**
  * Response to get a document and optionally revisions from an auditable item graph vertex.
  */
@@ -13,5 +13,5 @@ export interface IDocumentManagementGetResponse {
     /**
      * The body parameters.
      */
-    body: IDocument;
+    body: IDocumentList;
 }

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

@@ -0,0 +1,53 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+/**
+ * Request to get a document revision from an auditable item graph vertex.
+ */
+export interface IDocumentManagementGetRevisionRequest {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The full id of the document to get.
+         */
+        auditableItemGraphDocumentId: string;
+        /**
+         * The revision of the document to get.
+         */
+        revision: string;
+    };
+    /**
+     * The query parameters.
+     */
+    query?: {
+        /**
+         * Include the blob storage metadata in the response.
+         * @default false
+         */
+        includeBlobStorageMetadata?: boolean | string;
+        /**
+         * Include the blob storage data in the response.
+         * @default false
+         */
+        includeBlobStorageData?: boolean | string;
+        /**
+         * Include the attestation information in the response.
+         * @default false
+         */
+        includeAttestation?: boolean | string;
+        /**
+         * If provided will extract data from the document using the specified rule group id.
+         */
+        extractRuleGroupId?: string;
+        /**
+         * By default extraction will auto detect the mime type of the document, this can be used to override the detection.
+         */
+        extractMimeType?: string;
+    };
+}

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

@@ -0,0 +1,17 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+import type { IDocument } from "../IDocument";
+/**
+ * Response to get a document revision from an auditable item graph vertex.
+ */
+export interface IDocumentManagementGetRevisionResponse {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The body parameters.
+     */
+    body: IDocument;
+}

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

@@ -9,36 +9,21 @@ export interface IDocumentManagementQueryRequest {
     headers?: {
         [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
     };
-    /**
-     * The path parameters.
-     */
-    pathParams: {
-        /**
-         * The id of the auditable item graph vertex which contains the documents.
-         */
-        auditableItemGraphId: string;
-    };
     /**
      * The query parameters.
      */
-    query?: {
+    query: {
         /**
-         * List of comma separated document codes to filter the query.
+         * The id of the document id we are trying to find.
          */
-        documentCodes?: string;
-        /**
-         * Include deleted documents in the response.
-         * @default false
-         */
-        includeRemoved?: boolean;
-        /**
-         * Include the most recent 5 revisions, use the individual get to retrieve more.
-         * @default false
-         */
-        includeMostRecentRevisions?: boolean;
+        documentId: string;
         /**
          * The cursor to get the next chunk of documents.
          */
         cursor?: string;
+        /**
+         * The number of documents to return.
+         */
+        pageSize?: number | string;
     };
 }

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

@@ -1,5 +1,5 @@
+import type { IAuditableItemGraphVertexList } from "@twin.org/auditable-item-graph-models";
 import type { HeaderTypes, MimeTypes } from "@twin.org/web";
-import type { IDocumentList } from "../IDocumentList";
 /**
  * Response to query the documents from an auditable item graph vertex.
  */
@@ -13,5 +13,5 @@ export interface IDocumentManagementQueryResponse {
     /**
      * The body parameters.
      */
-    body: IDocumentList;
+    body: IAuditableItemGraphVertexList;
 }

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

@@ -1,5 +1,5 @@
 /**
- * Request to remove a document from an auditable item graph.
+ * Request to remove a document revision from an auditable item graph.
  */
 export interface IDocumentManagementRemoveRequest {
     /**
@@ -7,22 +7,12 @@ export interface IDocumentManagementRemoveRequest {
      */
     pathParams: {
         /**
-         * The id of the auditable item graph vertex to remove the document from.
+         * The id of the auditable item graph vertex to remove the revision from.
          */
-        auditableItemGraphId: string;
+        auditableItemGraphDocumentId: string;
         /**
-         * The full id of the document to remove.
+         * The revision of the document to remove.
          */
-        documentId: string;
-    };
-    /**
-     * The query parameters.
-     */
-    query?: {
-        /**
-         * Flag to remove all revisions of the document.
-         * @default false
-         */
-        removeAllRevisions?: boolean;
+        revision: string;
     };
 }

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

@@ -0,0 +1,36 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+/**
+ * Request to update a document as an auditable item graph vertex.
+ */
+export interface IDocumentManagementUpdateRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The full id of the document to get.
+         */
+        auditableItemGraphDocumentId: string;
+    };
+    /**
+     * The body parameters.
+     */
+    body: {
+        /**
+         * The data to create the document with, in base64.
+         */
+        blob?: string;
+        /**
+         * Additional information to associate with the document.
+         */
+        annotationObject?: IJsonLdNodeObject;
+        /**
+         * The auditable item graph vertices to connect the document to.
+         */
+        auditableItemGraphEdges?: {
+            id: string;
+            addAlias?: boolean;
+            aliasAnnotationObject?: IJsonLdNodeObject;
+        }[];
+    };
+}

package/dist/types/models/documentContexts.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The contexts of document management objects.
+ */
+export declare const DocumentContexts: {
+    /**
+     * The context root for the document types.
+     */
+    readonly ContextRoot: "https://schema.twindev.org/documents/";
+    /**
+     * The context root for the common types.
+     */
+    readonly ContextRootCommon: "https://schema.twindev.org/common/";
+};
+/**
+ * The contexts of document management objects.
+ */
+export type DocumentContexts = (typeof DocumentContexts)[keyof typeof DocumentContexts];

package/dist/types/models/documentTypes.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The types of document management objects.
+ */
+export declare const DocumentTypes: {
+    /**
+     * Represents a document.
+     */
+    readonly Document: "Document";
+    /**
+     * Represents a document attestation.
+     */
+    readonly DocumentAttestation: "DocumentAttestation";
+};
+/**
+ * The types of document management objects.
+ */
+export type DocumentTypes = (typeof DocumentTypes)[keyof typeof DocumentTypes];

package/docs/changelog.md

@@ -1,5 +1,108 @@
 # @twin.org/document-management-models - Changelog
 
-## v0.0.1-next.2
+## [0.0.1-next.20](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.19...document-management-models-v0.0.1-next.20) (2025-06-20)
+
+
+### Features
+
+* 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))
+* 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 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))
+
+
+### Bug Fixes
+
+* query params force coercion ([d667d0f](https://github.com/twinfoundation/document-management/commit/d667d0f195accca2887a5ca732e9790063763996))
+
+## [0.0.1-next.19](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.18...document-management-models-v0.0.1-next.19) (2025-06-20)
+
+
+### Bug Fixes
+
+* query params force coercion ([d667d0f](https://github.com/twinfoundation/document-management/commit/d667d0f195accca2887a5ca732e9790063763996))
+
+## [0.0.1-next.18](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.17...document-management-models-v0.0.1-next.18) (2025-06-18)
+
+
+### Miscellaneous Chores
+
+* **document-management-models:** Synchronize repo versions
+
+## [0.0.1-next.17](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.16...document-management-models-v0.0.1-next.17) (2025-06-12)
+
+
+### Features
+
+* update dependencies ([f9d8641](https://github.com/twinfoundation/document-management/commit/f9d86417dba24027699225ec7473296e361dcb00))
+
+## [0.0.1-next.16](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.15...document-management-models-v0.0.1-next.16) (2025-06-03)
+
+
+### Features
+
+* update ts-to-schema generation ([01a5335](https://github.com/twinfoundation/document-management/commit/01a5335372f6a4764a74d56c446d669724a308aa))
+
+## [0.0.1-next.15](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.14...document-management-models-v0.0.1-next.15) (2025-05-28)
+
+
+### Features
+
+* data type registration use fully qualified names ([18d27d0](https://github.com/twinfoundation/document-management/commit/18d27d0c21d0f652b7df4b409bb2d3c66cf22f84))
+
+## [0.0.1-next.14](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.13...document-management-models-v0.0.1-next.14) (2025-05-08)
+
+
+### Features
+
+* use standard list json ld types ([20ea04b](https://github.com/twinfoundation/document-management/commit/20ea04b05fd4bc4fcedce8f66958942c3c2fa303))
+
+## [0.0.1-next.13](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.12...document-management-models-v0.0.1-next.13) (2025-04-30)
+
+
+### Miscellaneous Chores
+
+* **document-management-models:** Synchronize repo versions
+
+## [0.0.1-next.12](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.11...document-management-models-v0.0.1-next.12) (2025-04-30)
+
+
+### Features
+
+* get document revision ([080eddc](https://github.com/twinfoundation/document-management/commit/080eddcc024c622dda6bb36f60f5fa80a86cf5bb))
+
+## [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/classes/DocumentManagementDataTypes.md

@@ -0,0 +1,25 @@
+# Class: DocumentManagementDataTypes
+
+Handle all the data types for document management.
+
+## Constructors
+
+### Constructor
+
+> **new DocumentManagementDataTypes**(): `DocumentManagementDataTypes`
+
+#### Returns
+
+`DocumentManagementDataTypes`
+
+## Methods
+
+### registerTypes()
+
+> `static` **registerTypes**(): `void`
+
+Register all the data types.
+
+#### Returns
+
+`void`