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

package/dist/types/documentManagementRoutes.d.ts

@@ -0,0 +1,45 @@
+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";
+/**
+ * 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[];
+/**
+ * Set a document in to 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>;
+/**
+ * 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>;
+/**
+ * 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,90 @@
+import { type IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import { type IDocument, 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 in 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 annotationObject Additional information to associate with the document.
+     * @param createAttestation Flag to create an attestation for the document, defaults to false.
+     * @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.
+     */
+    set(auditableItemGraphId: string, documentId: string, documentIdFormat: string | undefined, documentCode: UneceDocumentCodes, blob: Uint8Array, annotationObject?: IJsonLdNodeObject, createAttestation?: boolean, 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.
+     * @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 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?: {
+        includeBlobStorageMetadata?: boolean;
+        includeBlobStorageData?: boolean;
+        includeAttestation?: boolean;
+        includeRemoved?: boolean;
+        maxRevisionCount?: number;
+    }, revisionCursor?: string, userIdentity?: string, nodeIdentity?: string): Promise<IDocument>;
+    /**
+     * 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.
+     * @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>;
+    /**
+     * 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.
+     * @param cursor The cursor 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.
+     */
+    query(auditableItemGraphId: string, documentCodes?: UneceDocumentCodes[], options?: {
+        includeMostRecentRevisions?: boolean;
+        includeRemoved?: boolean;
+    }, cursor?: string, userIdentity?: string, nodeIdentity?: string): Promise<IDocumentList>;
+}

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,5 @@
+# @twin.org/document-management-service - Changelog
+
+## v0.0.1-next.2
+
+- Initial Release

package/docs/examples.md

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