@twin.org/document-management-service 0.0.1-next.3 → 0.0.1-next.5

package/dist/cjs/index.cjs

@@ -330,7 +330,11 @@ async function documentManagementSet(httpRequestContext, componentName, request)
     core.Guards.object(ROUTES_SOURCE, "request.body", request.body);
     core.Guards.stringBase64(ROUTES_SOURCE, "request.body.blob", request.body.blob);
     const component = core.ComponentFactory.get(componentName);
-    const id = await component.set(request.pathParams.auditableItemGraphId, request.body.documentId, request.body.documentIdFormat, request.body.documentCode, core.Converter.base64ToBytes(request.body.blob), request.body.annotationObject, request.body.createAttestation, httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
+    const id = await component.set(request.pathParams.auditableItemGraphId, request.body.documentId, request.body.documentIdFormat, request.body.documentCode, core.Converter.base64ToBytes(request.body.blob), request.body.annotationObject, {
+        createAttestation: request.body.createAttestation,
+        includeIdAsAlias: request.body.includeIdAsAlias,
+        aliasAnnotationObject: request.body.aliasAnnotationObject
+    }, httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
     return {
         statusCode: web.HttpStatusCode.created,
         headers: {
@@ -463,12 +467,15 @@ class DocumentManagementService {
      * @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 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 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.
      */
-    async set(auditableItemGraphId, documentId, documentIdFormat, documentCode, blob, annotationObject, createAttestation, userIdentity, nodeIdentity) {
+    async set(auditableItemGraphId, documentId, documentIdFormat, documentCode, blob, annotationObject, options, userIdentity, nodeIdentity) {
         core.Guards.stringValue(this.CLASS_NAME, "auditableItemGraphId", auditableItemGraphId);
         core.Guards.stringValue(this.CLASS_NAME, "documentId", documentId);
         core.Guards.arrayOneOf(this.CLASS_NAME, "documentCode", documentCode, Object.values(standardsUnece.UneceDocumentCodes));
@@ -478,14 +485,32 @@ class DocumentManagementService {
         try {
             const vertex = await this._auditableItemGraphComponent.get(auditableItemGraphId);
             vertex.resources = vertex.resources ?? [];
+            if (options?.includeIdAsAlias ?? false) {
+                vertex.aliases ??= [];
+                const found = vertex.aliases.find(a => a.id === documentId);
+                if (found) {
+                    found.annotationObject = options?.aliasAnnotationObject ?? found.annotationObject;
+                    found.aliasFormat = documentIdFormat ?? found.aliasFormat;
+                }
+                else {
+                    vertex.aliases.push({
+                        "@context": auditableItemGraphModels.AuditableItemGraphTypes.ContextRoot,
+                        type: auditableItemGraphModels.AuditableItemGraphTypes.Alias,
+                        id: documentId,
+                        aliasFormat: documentIdFormat,
+                        annotationObject: options?.aliasAnnotationObject
+                    });
+                }
+            }
             // Get all the docs from the AIG vertex
             const vertexDocs = this.filterDocumentsFromVertex(vertex);
             // Reduce the list to those with a matching id and code
             const matchingDocIds = this.findMatchingDocs(vertexDocs, documentId, documentCode, true);
             const currentRevision = matchingDocIds[0];
+            let createAttestation = options?.createAttestation ?? false;
             // If the create attestation flag is not defined we check to see if any previous
             // revisions have an attestation and if so we create one for the new revision.
-            if (core.Is.undefined(createAttestation)) {
+            if (core.Is.undefined(options?.createAttestation)) {
                 createAttestation = matchingDocIds.some(d => core.Is.stringValue(d.attestationId));
             }
             // Calculate the hash for the blob.
@@ -504,7 +529,7 @@ class DocumentManagementService {
                     updated = true;
                 }
                 if (updated) {
-                    currentRevision.dateModified = new Date().toISOString();
+                    currentRevision.dateModified = new Date(Date.now()).toISOString();
                     await this._auditableItemGraphComponent.update(vertex, userIdentity, nodeIdentity);
                 }
                 return currentRevision.id;

package/dist/esm/index.mjs

@@ -328,7 +328,11 @@ async function documentManagementSet(httpRequestContext, componentName, request)
     Guards.object(ROUTES_SOURCE, "request.body", request.body);
     Guards.stringBase64(ROUTES_SOURCE, "request.body.blob", request.body.blob);
     const component = ComponentFactory.get(componentName);
-    const id = await component.set(request.pathParams.auditableItemGraphId, request.body.documentId, request.body.documentIdFormat, request.body.documentCode, Converter.base64ToBytes(request.body.blob), request.body.annotationObject, request.body.createAttestation, httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
+    const id = await component.set(request.pathParams.auditableItemGraphId, request.body.documentId, request.body.documentIdFormat, request.body.documentCode, Converter.base64ToBytes(request.body.blob), request.body.annotationObject, {
+        createAttestation: request.body.createAttestation,
+        includeIdAsAlias: request.body.includeIdAsAlias,
+        aliasAnnotationObject: request.body.aliasAnnotationObject
+    }, httpRequestContext.userIdentity, httpRequestContext.nodeIdentity);
     return {
         statusCode: HttpStatusCode.created,
         headers: {
@@ -461,12 +465,15 @@ class DocumentManagementService {
      * @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 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 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.
      */
-    async set(auditableItemGraphId, documentId, documentIdFormat, documentCode, blob, annotationObject, createAttestation, userIdentity, nodeIdentity) {
+    async set(auditableItemGraphId, documentId, documentIdFormat, documentCode, blob, annotationObject, options, userIdentity, nodeIdentity) {
         Guards.stringValue(this.CLASS_NAME, "auditableItemGraphId", auditableItemGraphId);
         Guards.stringValue(this.CLASS_NAME, "documentId", documentId);
         Guards.arrayOneOf(this.CLASS_NAME, "documentCode", documentCode, Object.values(UneceDocumentCodes));
@@ -476,14 +483,32 @@ class DocumentManagementService {
         try {
             const vertex = await this._auditableItemGraphComponent.get(auditableItemGraphId);
             vertex.resources = vertex.resources ?? [];
+            if (options?.includeIdAsAlias ?? false) {
+                vertex.aliases ??= [];
+                const found = vertex.aliases.find(a => a.id === documentId);
+                if (found) {
+                    found.annotationObject = options?.aliasAnnotationObject ?? found.annotationObject;
+                    found.aliasFormat = documentIdFormat ?? found.aliasFormat;
+                }
+                else {
+                    vertex.aliases.push({
+                        "@context": AuditableItemGraphTypes.ContextRoot,
+                        type: AuditableItemGraphTypes.Alias,
+                        id: documentId,
+                        aliasFormat: documentIdFormat,
+                        annotationObject: options?.aliasAnnotationObject
+                    });
+                }
+            }
             // Get all the docs from the AIG vertex
             const vertexDocs = this.filterDocumentsFromVertex(vertex);
             // Reduce the list to those with a matching id and code
             const matchingDocIds = this.findMatchingDocs(vertexDocs, documentId, documentCode, true);
             const currentRevision = matchingDocIds[0];
+            let createAttestation = options?.createAttestation ?? false;
             // If the create attestation flag is not defined we check to see if any previous
             // revisions have an attestation and if so we create one for the new revision.
-            if (Is.undefined(createAttestation)) {
+            if (Is.undefined(options?.createAttestation)) {
                 createAttestation = matchingDocIds.some(d => Is.stringValue(d.attestationId));
             }
             // Calculate the hash for the blob.
@@ -502,7 +527,7 @@ class DocumentManagementService {
                     updated = true;
                 }
                 if (updated) {
-                    currentRevision.dateModified = new Date().toISOString();
+                    currentRevision.dateModified = new Date(Date.now()).toISOString();
                     await this._auditableItemGraphComponent.update(vertex, userIdentity, nodeIdentity);
                 }
                 return currentRevision.id;

package/dist/types/documentManagementService.d.ts

@@ -29,12 +29,19 @@ export declare class DocumentManagementService implements IDocumentManagementCom
      * @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 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 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>;
+    set(auditableItemGraphId: string, documentId: string, documentIdFormat: string | undefined, documentCode: UneceDocumentCodes, blob: Uint8Array, annotationObject?: IJsonLdNodeObject, options?: {
+        createAttestation?: boolean;
+        includeIdAsAlias?: 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.

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/document-management-service - Changelog
 
-## v0.0.1-next.3
+## v0.0.1-next.5
 
 - Initial Release

package/docs/open-api/spec.json

@@ -1079,6 +1079,13 @@
 					"createAttestation": {
 						"type": "boolean",
 						"description": "Flag to create an attestation for the document, defaults to false"
+					},
+					"includeIdAsAlias": {
+						"type": "boolean",
+						"description": "Include the document id as an alias to the aig vertex, defaults to false."
+					},
+					"aliasAnnotationObject": {
+						"$ref": "#/components/schemas/JsonLdNodeObject"
 					}
 				},
 				"required": [

package/docs/reference/classes/DocumentManagementService.md

@@ -50,7 +50,7 @@ Runtime name for the class.
 
 ### set()
 
-> **set**(`auditableItemGraphId`, `documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject`?, `createAttestation`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
+> **set**(`auditableItemGraphId`, `documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject`?, `options`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
 
 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.
@@ -94,12 +94,28 @@ The data to create the document.
 
 Additional information to associate with the document.
 
-##### createAttestation?
+##### options?
+
+Additional options for the set operation.
+
+###### createAttestation?
 
 `boolean`
 
 Flag to create an attestation for the document, defaults to false.
 
+###### includeIdAsAlias?
+
+`boolean`
+
+Include the document id as an alias to the aig vertex, defaults to false.
+
+###### aliasAnnotationObject?
+
+`IJsonLdNodeObject`
+
+Additional information to associate with the alias.
+
 ##### userIdentity?
 
 `string`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/document-management-service",
-	"version": "0.0.1-next.3",
+	"version": "0.0.1-next.5",
 	"description": "Document management contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -21,7 +21,7 @@
 		"@twin.org/core": "next",
 		"@twin.org/crypto": "next",
 		"@twin.org/data-json-ld": "next",
-		"@twin.org/document-management-models": "0.0.1-next.3",
+		"@twin.org/document-management-models": "0.0.1-next.5",
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-models": "next",
 		"@twin.org/nameof": "next",