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

package/dist/types/documentManagementRoutes.d.ts

@@ -1,5 +1,5 @@
-import { type ICreatedResponse, type IHttpRequestContext, type INoContentResponse, type IRestRoute, type ITag } from "@twin.org/api-models";
-import { type IDocumentManagementGetRequest, type IDocumentManagementGetResponse, type IDocumentManagementQueryRequest, type IDocumentManagementQueryResponse, type IDocumentManagementRemoveRequest, type IDocumentManagementSetRequest } from "@twin.org/document-management-models";
+import type { ICreatedResponse, IHttpRequestContext, INoContentResponse, IRestRoute, ITag } from "@twin.org/api-models";
+import { type IDocumentManagementCreateRequest, type IDocumentManagementGetRequest, type IDocumentManagementGetResponse, type IDocumentManagementQueryRequest, type IDocumentManagementQueryResponse, type IDocumentManagementRemoveRequest, type IDocumentManagementUpdateRequest } from "@twin.org/document-management-models";
 /**
  * The tag to associate with the routes.
  */
@@ -12,13 +12,13 @@ export declare const tagsDocumentManagement: ITag[];
  */
 export declare function generateRestRoutesDocumentManagement(baseRouteName: string, componentName: string): IRestRoute[];
 /**
- * Set a document in to an auditable item graph vertex.
+ * Create a document as an auditable item graph vertex.
  * @param httpRequestContext The request context for the API.
  * @param componentName The name of the component to use in the routes.
  * @param request The request.
  * @returns The response object with additional http response properties.
  */
-export declare function documentManagementSet(httpRequestContext: IHttpRequestContext, componentName: string, request: IDocumentManagementSetRequest): Promise<ICreatedResponse>;
+export declare function documentManagementCreate(httpRequestContext: IHttpRequestContext, componentName: string, request: IDocumentManagementCreateRequest): Promise<ICreatedResponse>;
 /**
  * Get the document from the auditable item graph vertex.
  * @param httpRequestContext The request context for the API.
@@ -27,6 +27,14 @@ export declare function documentManagementSet(httpRequestContext: IHttpRequestCo
  * @returns The response object with additional http response properties.
  */
 export declare function documentManagementGet(httpRequestContext: IHttpRequestContext, componentName: string, request: IDocumentManagementGetRequest): Promise<IDocumentManagementGetResponse>;
+/**
+ * UPdate the document from the auditable item graph vertex.
+ * @param httpRequestContext The request context for the API.
+ * @param componentName The name of the component to use in the routes.
+ * @param request The request.
+ * @returns The response object with additional http response properties.
+ */
+export declare function documentManagementUpdate(httpRequestContext: IHttpRequestContext, componentName: string, request: IDocumentManagementUpdateRequest): Promise<INoContentResponse>;
 /**
  * Remove the document from the auditable item graph vertex.
  * @param httpRequestContext The request context for the API.

package/dist/types/documentManagementService.d.ts

@@ -1,5 +1,6 @@
+import { type IAuditableItemGraphVertexList } from "@twin.org/auditable-item-graph-models";
 import { type IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import { type IDocument, type IDocumentList, type IDocumentManagementComponent } from "@twin.org/document-management-models";
+import { type IDocumentList, type IDocumentManagementComponent } from "@twin.org/document-management-models";
 import { UneceDocumentCodes } from "@twin.org/standards-unece";
 import type { IDocumentManagementServiceConstructorOptions } from "./models/IDocumentManagementStorageServiceConstructorOptions";
 /**
@@ -20,80 +21,89 @@ export declare class DocumentManagementService implements IDocumentManagementCom
      */
     constructor(options?: IDocumentManagementServiceConstructorOptions);
     /**
-     * Store a document in an auditable item graph vertex and add its content to blob storage.
+     * Store 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.
+     * @param blob The data to create the document with.
      * @param annotationObject Additional information to associate with the document.
+     * @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.includeIdAsAlias Include the document id as an alias to the aig vertex, defaults to false.
-     * @param options.aliasAnnotationObject Additional information to associate with the alias.
+     * @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, options?: {
+    create(documentId: string, documentIdFormat: string | undefined, documentCode: UneceDocumentCodes, blob: Uint8Array, annotationObject?: IJsonLdNodeObject, auditableItemGraphEdges?: {
+        id: string;
+        addAlias?: boolean;
+        aliasAnnotationObject?: IJsonLdNodeObject;
+    }[], options?: {
         createAttestation?: boolean;
-        includeIdAsAlias?: 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 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>;
+    }, 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.
+     * 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>;
     /**
      * Create an attestation for the document.
      * @param document The document to create the attestation for.

package/docs/changelog.md

@@ -1,5 +1,19 @@
 # @twin.org/document-management-service - Changelog
 
+## [0.0.1-next.9](https://github.com/twinfoundation/document-management/compare/document-management-service-v0.0.1-next.8...document-management-service-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))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/document-management-models bumped from 0.0.1-next.8 to 0.0.1-next.9
+
 ## [0.0.1-next.8](https://github.com/twinfoundation/document-management/compare/document-management-service-v0.0.1-next.7...document-management-service-v0.0.1-next.8) (2025-03-28)