@twin.org/document-management-rest-client 0.0.1-next.2 → 0.0.1-next.5

package/dist/cjs/index.cjs

@@ -37,10 +37,13 @@ class DocumentManagementClient extends apiCore.BaseRestClient {
      * @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.
      * @returns The identifier for the document which includes the auditable item graph identifier.
      */
-    async set(auditableItemGraphId, documentId, documentIdFormat, documentCode, blob, annotationObject, createAttestation) {
+    async set(auditableItemGraphId, documentId, documentIdFormat, documentCode, blob, annotationObject, options) {
         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));
@@ -55,7 +58,9 @@ class DocumentManagementClient extends apiCore.BaseRestClient {
                 documentCode,
                 blob: core.Converter.bytesToBase64(blob),
                 annotationObject,
-                createAttestation
+                createAttestation: options?.createAttestation,
+                includeIdAsAlias: options?.includeIdAsAlias,
+                aliasAnnotationObject: options?.aliasAnnotationObject
             }
         });
         return response.headers.location;

package/dist/esm/index.mjs

@@ -35,10 +35,13 @@ class DocumentManagementClient extends BaseRestClient {
      * @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.
      * @returns The identifier for the document which includes the auditable item graph identifier.
      */
-    async set(auditableItemGraphId, documentId, documentIdFormat, documentCode, blob, annotationObject, createAttestation) {
+    async set(auditableItemGraphId, documentId, documentIdFormat, documentCode, blob, annotationObject, options) {
         Guards.stringValue(this.CLASS_NAME, "auditableItemGraphId", auditableItemGraphId);
         Guards.stringValue(this.CLASS_NAME, "documentId", documentId);
         Guards.arrayOneOf(this.CLASS_NAME, "documentCode", documentCode, Object.values(UneceDocumentCodes));
@@ -53,7 +56,9 @@ class DocumentManagementClient extends BaseRestClient {
                 documentCode,
                 blob: Converter.bytesToBase64(blob),
                 annotationObject,
-                createAttestation
+                createAttestation: options?.createAttestation,
+                includeIdAsAlias: options?.includeIdAsAlias,
+                aliasAnnotationObject: options?.aliasAnnotationObject
             }
         });
         return response.headers.location;

package/dist/types/documentManagementClient.d.ts

@@ -26,10 +26,17 @@ export declare class DocumentManagementClient extends BaseRestClient implements
      * @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.
      * @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): Promise<string>;
+    set(auditableItemGraphId: string, documentId: string, documentIdFormat: string | undefined, documentCode: UneceDocumentCodes, blob: Uint8Array, annotationObject?: IJsonLdNodeObject, options?: {
+        createAttestation?: boolean;
+        includeIdAsAlias?: boolean;
+        aliasAnnotationObject?: IJsonLdNodeObject;
+    }): 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-rest-client - Changelog
 
-## v0.0.1-next.2
+## v0.0.1-next.5
 
 - Initial Release

package/docs/reference/classes/DocumentManagementClient.md

@@ -50,7 +50,7 @@ Runtime name for the class.
 
 ### set()
 
-> **set**(`auditableItemGraphId`, `documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject`?, `createAttestation`?): `Promise`\<`string`\>
+> **set**(`auditableItemGraphId`, `documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject`?, `options`?): `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.
+
 #### Returns
 
 `Promise`\<`string`\>
@@ -136,31 +152,31 @@ The identifier of the document to get.
 
 Additional options for the get operation.
 
-###### includeBlobStorageMetadata
+###### includeBlobStorageMetadata?
 
 `boolean`
 
 Flag to include the blob storage metadata for the document, defaults to false.
 
-###### includeBlobStorageData
+###### includeBlobStorageData?
 
 `boolean`
 
 Flag to include the blob storage data for the document, defaults to false.
 
-###### includeAttestation
+###### includeAttestation?
 
 `boolean`
 
 Flag to include the attestation information for the document, defaults to false.
 
-###### includeRemoved
+###### includeRemoved?
 
 `boolean`
 
 Flag to include deleted documents, defaults to false.
 
-###### maxRevisionCount
+###### maxRevisionCount?
 
 `number`
 
@@ -209,7 +225,7 @@ The identifier of the document to remove.
 
 Additional options for the remove operation.
 
-###### removeAllRevisions
+###### removeAllRevisions?
 
 `boolean`
 
@@ -251,13 +267,13 @@ The document codes to query for, if undefined gets all document codes.
 
 Additional options for the query operation.
 
-###### includeMostRecentRevisions
+###### includeMostRecentRevisions?
 
 `boolean`
 
 Include the most recent 5 revisions, use the individual get to retrieve more.
 
-###### includeRemoved
+###### includeRemoved?
 
 `boolean`
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/document-management-rest-client",
-	"version": "0.0.1-next.2",
+	"version": "0.0.1-next.5",
 	"description": "Document management contract implementation which can connect to REST endpoints",
 	"repository": {
 		"type": "git",
@@ -18,7 +18,7 @@
 		"@twin.org/api-models": "next",
 		"@twin.org/core": "next",
 		"@twin.org/data-json-ld": "next",
-		"@twin.org/document-management-models": "0.0.1-next.2",
+		"@twin.org/document-management-models": "0.0.1-next.5",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-unece": "next",