Merge remote-tracking branch 'origin/master' into release

Author: dynabic-billing-team

README.md

@@ -16,6 +16,15 @@ Feel free to explore the [Developer's Guide](https://docs.aspose.cloud/display/w
 - Add & remove watermarks and protection.
 - Read & write access to Document Object Model.
 
+## Enhancements in Version 24.9
+
+- Added digital signature methds for DOC, DOCX, XPS, or ODT documents.
+- Added ReplaceBackslashWithYenSign property for XpsSaveOptions and HtmlSaveOptions.
+- Added DigitalSignature property for XpsSaveOptions.
+- Added UseSdtTagAsFormFieldName property for PdfSaveOptions.
+- Added MergeWholeDocument parameter to the MailMerge operations to update fields in whole document after executing of a mail merge with regions.
+
+
 ## Enhancements in Version 24.8
 
 - Added the support of OpenType standard. It is usefull for languages required advanced typography.

TestData/DocumentActions/Signature/morzal.pfx

@@ -1,6 +1,6 @@
 {
   "name": "asposewordscloud",
-  "version": "24.8.0",
+  "version": "24.9.0",
   "description": "Aspose.Words Cloud SDK for Node.js",
   "homepage": "https://products.aspose.cloud/words/cloud",
   "author": {

TestData/DocumentActions/Signature/signedDocument.docx

@@ -3339,6 +3339,42 @@ export class WordsApi implements Encryptor {
         return Promise.resolve(result);
     }
 
+    /**
+     * Gets signatures from the document.
+     * @param requestObj contains request parameters
+     */
+    public async getSignatures(requestObj: model.GetSignaturesRequest): Promise< model.WordsIncomingMessage< model.SignatureCollectionResponse > > {
+        if (requestObj === null || requestObj === undefined) {
+            throw new Error('Required parameter "request" was null or undefined when calling getSignatures.');
+        }
+
+        const requestOptions = await requestObj.createRequestOptions(this.configuration, this); 
+
+        const response = await invokeApiMethod(requestOptions, this.configuration);
+        const result = new model.WordsIncomingMessage< model.SignatureCollectionResponse >();    
+        result.response = response;
+        result.body = requestObj.createResponse(response.body, response.headers);
+        return Promise.resolve(result);
+    }
+
+    /**
+     * Gets signatures from the document.
+     * @param requestObj contains request parameters
+     */
+    public async getSignaturesOnline(requestObj: model.GetSignaturesOnlineRequest): Promise< model.WordsIncomingMessage< model.SignatureCollectionResponse > > {
+        if (requestObj === null || requestObj === undefined) {
+            throw new Error('Required parameter "request" was null or undefined when calling getSignaturesOnline.');
+        }
+
+        const requestOptions = await requestObj.createRequestOptions(this.configuration, this); 
+
+        const response = await invokeApiMethod(requestOptions, this.configuration);
+        const result = new model.WordsIncomingMessage< model.SignatureCollectionResponse >();    
+        result.response = response;
+        result.body = requestObj.createResponse(response.body, response.headers);
+        return Promise.resolve(result);
+    }
+
     /**
      * Reads a StructuredDocumentTag (SDT) from the document node.
      * @param requestObj contains request parameters
@@ -4765,6 +4801,42 @@ export class WordsApi implements Encryptor {
         return Promise.resolve(result);
     }
 
+    /**
+     * Removes all signatures of the document.
+     * @param requestObj contains request parameters
+     */
+    public async removeAllSignatures(requestObj: model.RemoveAllSignaturesRequest): Promise< model.WordsIncomingMessage< model.SignatureCollectionResponse > > {
+        if (requestObj === null || requestObj === undefined) {
+            throw new Error('Required parameter "request" was null or undefined when calling removeAllSignatures.');
+        }
+
+        const requestOptions = await requestObj.createRequestOptions(this.configuration, this); 
+
+        const response = await invokeApiMethod(requestOptions, this.configuration);
+        const result = new model.WordsIncomingMessage< model.SignatureCollectionResponse >();    
+        result.response = response;
+        result.body = requestObj.createResponse(response.body, response.headers);
+        return Promise.resolve(result);
+    }
+
+    /**
+     * Removes all signatures of the document.
+     * @param requestObj contains request parameters
+     */
+    public async removeAllSignaturesOnline(requestObj: model.RemoveAllSignaturesOnlineRequest): Promise< model.WordsIncomingMessage< model.RemoveAllSignaturesOnlineResponse > > {
+        if (requestObj === null || requestObj === undefined) {
+            throw new Error('Required parameter "request" was null or undefined when calling removeAllSignaturesOnline.');
+        }
+
+        const requestOptions = await requestObj.createRequestOptions(this.configuration, this); 
+
+        const response = await invokeApiMethod(requestOptions, this.configuration);
+        const result = new model.WordsIncomingMessage< model.RemoveAllSignaturesOnlineResponse >();
+        result.response = response;
+        result.body = requestObj.createResponse(response.body, response.headers);
+        return Promise.resolve(result);
+    }
+
     /**
      * Removes a range from the document.
      * @param requestObj contains request parameters
@@ -5214,6 +5286,42 @@ export class WordsApi implements Encryptor {
         return Promise.resolve(result);
     }
 
+    /**
+     * Signs the document with given certificate.
+     * @param requestObj contains request parameters
+     */
+    public async signDocument(requestObj: model.SignDocumentRequest): Promise< model.WordsIncomingMessage< model.SignatureCollectionResponse > > {
+        if (requestObj === null || requestObj === undefined) {
+            throw new Error('Required parameter "request" was null or undefined when calling signDocument.');
+        }
+
+        const requestOptions = await requestObj.createRequestOptions(this.configuration, this); 
+
+        const response = await invokeApiMethod(requestOptions, this.configuration);
+        const result = new model.WordsIncomingMessage< model.SignatureCollectionResponse >();    
+        result.response = response;
+        result.body = requestObj.createResponse(response.body, response.headers);
+        return Promise.resolve(result);
+    }
+
+    /**
+     * Signs the document with given certificate.
+     * @param requestObj contains request parameters
+     */
+    public async signDocumentOnline(requestObj: model.SignDocumentOnlineRequest): Promise< model.WordsIncomingMessage< model.SignDocumentOnlineResponse > > {
+        if (requestObj === null || requestObj === undefined) {
+            throw new Error('Required parameter "request" was null or undefined when calling signDocumentOnline.');
+        }
+
+        const requestOptions = await requestObj.createRequestOptions(this.configuration, this); 
+
+        const response = await invokeApiMethod(requestOptions, this.configuration);
+        const result = new model.WordsIncomingMessage< model.SignDocumentOnlineResponse >();
+        result.response = response;
+        result.body = requestObj.createResponse(response.body, response.headers);
+        return Promise.resolve(result);
+    }
+
     /**
      * Splits a document into parts and saves them in the specified format.
      * @param requestObj contains request parameters

TestData/DocumentActions/Signature/unsignedDocument.docx

@@ -131,7 +131,7 @@ async function invokeApiMethodInternal(requestOptions: request.OptionsWithUri, c
     requestOptions.timeout = 1000 * confguration.timeout;
 
     requestOptions.headers["x-aspose-client"] = "nodejs sdk";
-    requestOptions.headers["x-aspose-client-version"] = "24.8";
+    requestOptions.headers["x-aspose-client-version"] = "24.9";
     requestOptions.encoding = null;
 
 	requestOptions.uri = encodeURI(requestOptions.uri.toString());

package.json

@@ -0,0 +1,86 @@
+/*
+ * --------------------------------------------------------------------------------
+ * <copyright company="Aspose" file="digitalSignatureDetails.ts">
+ *   Copyright (c) 2024 Aspose.Words for Cloud
+ * </copyright>
+ * <summary>
+ *   Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ * 
+ *  The above copyright notice and this permission notice shall be included in all
+ *  copies or substantial portions of the Software.
+ * 
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ *  SOFTWARE.
+ * </summary>
+ * --------------------------------------------------------------------------------
+ */
+
+import { AttributeInfo } from '../internal/attributeInfo';
+import { ModelInterface } from './modelInterface';
+import { SignOptions } from './signOptions';
+
+export const importsMapDigitalSignatureDetails = {
+    SignOptions,
+};
+
+/**
+ * Container class for details of digital signature.
+ */
+export class DigitalSignatureDetails implements ModelInterface {
+    /**
+     * Attribute type map
+     */
+    public static attributeTypeMap: Array<AttributeInfo> = [
+        {
+            name: "certificateFilename",
+            baseName: "CertificateFilename",
+            type: "string",
+        },
+        {
+            name: "signOptions",
+            baseName: "SignOptions",
+            type: "SignOptions",
+        }
+    ];
+
+    /**
+     * Returns attribute type map
+     */
+    public static getAttributeTypeMap() {
+        return DigitalSignatureDetails.attributeTypeMap;
+    }
+
+    /**
+     * Gets or sets the certificate's filename using for signing.
+     */
+    public certificateFilename: string;
+
+    /**
+     * Gets or sets signing options.
+     */
+    public signOptions: SignOptions;
+
+    public constructor(init?: Partial< DigitalSignatureDetails >) {
+        Object.assign(this, init);
+    }
+
+    public collectFilesContent(_resultFilesContent: Array<any>) {
+    }
+
+    public validate() {
+
+        this.signOptions?.validate();
+
+    }
+}
+

src/api.ts

@@ -206,6 +206,11 @@ export class HtmlSaveOptionsData extends SaveOptionsData {
             baseName: "PrettyFormat",
             type: "boolean",
         },
+        {
+            name: "replaceBackslashWithYenSign",
+            baseName: "ReplaceBackslashWithYenSign",
+            type: "boolean",
+        },
         {
             name: "resolveFontNames",
             baseName: "ResolveFontNames",
@@ -419,6 +424,15 @@ export class HtmlSaveOptionsData extends SaveOptionsData {
      */
     public prettyFormat: boolean;
 
+    /**
+     * Gets or sets the flag that indicates whether backslash characters should be replaced with yen signs.
+     * Default value is false.
+     * By default, Aspose.Words mimics MS Word's behavior and doesn't replace backslash characters with yen signs in
+     * generated HTML documents. However, previous versions of Aspose.Words performed such replacements in certain
+     * scenarios. This flag enables backward compatibility with previous versions of Aspose.Words.
+     */
+    public replaceBackslashWithYenSign: boolean;
+
     /**
      * Gets or sets a value indicating whether font family names used in the document are resolved and substituted according to FontSettings when being written into HTML-based formats.
      * The default value is false.