@twin.org/document-management-models 0.0.1-next.3 → 0.0.1-next.4

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

@@ -17,12 +17,19 @@ export interface IDocumentManagementComponent extends IComponent {
      * @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 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/dist/types/models/api/IDocumentManagementSetRequest.d.ts

@@ -41,5 +41,13 @@ export interface IDocumentManagementSetRequest {
          * Flag to create an attestation for the document, defaults to false
          */
         createAttestation?: boolean;
+        /**
+         * Include the document id as an alias to the aig vertex, defaults to false.
+         */
+        includeIdAsAlias?: boolean;
+        /**
+         * Additional information to associate with the alias.
+         */
+        aliasAnnotationObject?: IJsonLdNodeObject;
     };
 }

package/docs/changelog.md

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

package/docs/reference/interfaces/IDocumentManagementComponent.md

@@ -10,7 +10,7 @@ Interface describing an document management contract.
 
 ### 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.
@@ -54,12 +54,28 @@ The data to create the document with.
 
 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/docs/reference/interfaces/IDocumentManagementSetRequest.md

@@ -59,3 +59,15 @@ Additional information to associate with the document.
 > `optional` **createAttestation**: `boolean`
 
 Flag to create an attestation for the document, defaults to false
+
+#### includeIdAsAlias?
+
+> `optional` **includeIdAsAlias**: `boolean`
+
+Include the document id as an alias to the aig vertex, defaults to false.
+
+#### aliasAnnotationObject?
+
+> `optional` **aliasAnnotationObject**: `IJsonLdNodeObject`
+
+Additional information to associate with the alias.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/document-management-models",
-	"version": "0.0.1-next.3",
+	"version": "0.0.1-next.4",
 	"description": "Models which define the structure of the document management connectors and services",
 	"repository": {
 		"type": "git",