@twin.org/document-management-service 0.0.1-next.10

package/dist/types/documentManagementRoutes.d.ts

@@ -0,0 +1,53 @@
+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.
+ */
+export declare const tagsDocumentManagement: ITag[];
+/**
+ * The REST routes for document management.
+ * @param baseRouteName Prefix to prepend to the paths.
+ * @param componentName The name of the component to use in the routes stored in the ComponentFactory.
+ * @returns The generated routes.
+ */
+export declare function generateRestRoutesDocumentManagement(baseRouteName: string, componentName: string): IRestRoute[];
+/**
+ * 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 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.
+ * @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 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.
+ * @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 documentManagementRemove(httpRequestContext: IHttpRequestContext, componentName: string, request: IDocumentManagementRemoveRequest): Promise<INoContentResponse>;
+/**
+ * Query the documents from 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 documentManagementQuery(httpRequestContext: IHttpRequestContext, componentName: string, request: IDocumentManagementQueryRequest): Promise<IDocumentManagementQueryResponse>;

package/dist/types/documentManagementService.d.ts

@@ -0,0 +1,115 @@
+import { type IAuditableItemGraphVertexList } from "@twin.org/auditable-item-graph-models";
+import { type IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import { type IDocumentList, type IDocumentManagementComponent } from "@twin.org/document-management-models";
+import { UneceDocumentCodes } from "@twin.org/standards-unece";
+import type { IDocumentManagementServiceConstructorOptions } from "./models/IDocumentManagementStorageServiceConstructorOptions";
+/**
+ * Service for performing document management operations.
+ */
+export declare class DocumentManagementService implements IDocumentManagementComponent {
+    /**
+     * The namespace supported by the document management service.
+     */
+    static readonly NAMESPACE: string;
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of DocumentManagementService.
+     * @param options The options for the service.
+     */
+    constructor(options?: IDocumentManagementServiceConstructorOptions);
+    /**
+     * 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 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 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 auditable item graph vertex created for the document including its revision.
+     */
+    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>;
+    /**
+     * 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 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(auditableItemGraphDocumentId: string, options?: {
+        includeBlobStorageMetadata?: boolean;
+        includeBlobStorageData?: boolean;
+        includeAttestation?: boolean;
+        includeRemoved?: boolean;
+    }, cursor?: string, pageSize?: number, userIdentity?: string, nodeIdentity?: string): Promise<IDocumentList>;
+    /**
+     * 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.
+     */
+    removeRevision(auditableItemGraphDocumentId: string, revision: number, userIdentity?: string, nodeIdentity?: string): Promise<void>;
+    /**
+     * 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 graph vertices that contain documents referencing the specified document id.
+     */
+    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.
+     * @param userIdentity The identity to perform the attestation operation with.
+     * @param nodeIdentity The node identity to perform attestation operation with.
+     * @returns The attestation identifier.
+     */
+    private createAttestation;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./documentManagementRoutes";
+export * from "./documentManagementService";
+export * from "./models/IDocumentManagementServiceConfig";
+export * from "./models/IDocumentManagementStorageServiceConstructorOptions";
+export * from "./restEntryPoints";

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

@@ -0,0 +1,5 @@
+/**
+ * Configuration for the document management service.
+ */
+export interface IDocumentManagementServiceConfig {
+}

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

@@ -0,0 +1,25 @@
+import type { IDocumentManagementServiceConfig } from "./IDocumentManagementServiceConfig";
+/**
+ * Options for the document management Service constructor.
+ */
+export interface IDocumentManagementServiceConstructorOptions {
+    /**
+     * The type of the auditable item graph component.
+     * @default auditable-item-graph
+     */
+    auditableItemGraphComponentType?: string;
+    /**
+     * The type of the blob storage component.
+     * @default blob-storage
+     */
+    blobStorageComponentType?: string;
+    /**
+     * The type of the attestation component.
+     * @default attestation
+     */
+    attestationComponentType?: string;
+    /**
+     * The configuration for the service.
+     */
+    config?: IDocumentManagementServiceConfig;
+}

package/dist/types/restEntryPoints.d.ts

@@ -0,0 +1,2 @@
+import type { IRestRouteEntryPoint } from "@twin.org/api-models";
+export declare const restEntryPoints: IRestRouteEntryPoint[];

package/docs/changelog.md

@@ -0,0 +1,47 @@
+# @twin.org/document-management-service - Changelog
+
+## [0.0.1-next.10](https://github.com/twinfoundation/document-management/compare/document-management-service-v0.0.1-next.9...document-management-service-v0.0.1-next.10) (2025-04-25)
+
+
+### Bug Fixes
+
+* adding missing route for the document management ([#4](https://github.com/twinfoundation/document-management/issues/4)) ([fd3292e](https://github.com/twinfoundation/document-management/commit/fd3292ede5014847ae2f2bcadb174b6552486154))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/document-management-models bumped from 0.0.1-next.9 to 0.0.1-next.10
+
+## [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)
+
+
+### Miscellaneous Chores
+
+* **document-management-service:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/document-management-models bumped from 0.0.1-next.7 to 0.0.1-next.8
+
+## v0.0.1-next.7
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/document-management-service - Examples