Merge pull request #132 from aspose-pdf-cloud/develop

update to 25.6

Author: boiledgas

README.md

@@ -30,8 +30,8 @@ XLS, XLSX, PPTX, DOC, DOCX, MobiXML, JPEG, EMF, PNG, BMP, GIF, TIFF, Text
 ## Read PDF Formats
 MHT, PCL, PS, XSLFO, MD
 
-## Enhancements in Version 25.5
-- Add a method for comparing pdf files.
+## Enhancements in Version 25.6
+- Develop Rotate Document Pages method.
 - A new version of Aspose.PDF Cloud was prepared using the latest version of Aspose.PDF for .NET.
 
 ## Installation

UsesCases/Compares/comparePdfDocuments.js

@@ -0,0 +1,34 @@
+import path from 'node:path';
+import { pdfComparesHelper, pdfApi } from "../Compares/comparesHelper.js";
+
+export const configParams = {
+    LOCAL_FOLDER: "C:\\Samples\\",
+    REMOTE_FOLDER: "Your_Temp_Pdf_Cloud",
+    PDF_DOCUMENT_1: "sample_compare_1.pdf",
+    PDF_DOCUMENT_2: "sample_compare_2.pdf",
+    PDF_OUTPUT: "output_compare.pdf",
+    REMOTE_FOLDER: "Your_Temp_Pdf_Cloud",
+};
+
+export const pdfCompares = {
+    async comparePdfDocuments(document1, document2, output_document) {
+        await pdfComparesHelper.uploadFile(document1, configParams.LOCAL_FOLDER, configParams.REMOTE_FOLDER);
+        await pdfComparesHelper.uploadFile(document2, configParams.LOCAL_FOLDER, configParams.REMOTE_FOLDER);
+
+        const remotePdf1 = path.join(configParams.REMOTE_FOLDER, document1);
+        const remotePdf2 = path.join(configParams.REMOTE_FOLDER, document2);
+        var remotePdfOut = path.join(configParams.REMOTE_FOLDER, output_document);
+
+        const response = await pdfApi.postComparePdf(remotePdf1, remotePdf2, remotePdfOut);
+        
+        if (response.body.code != 200) {
+            console.log("Unexpected error!");
+        }
+        else{
+            console.log("Compare was successful!y finished in '" + output_document + "' file.");
+            await pdfComparesHelper.downloadResult(output_document, configParams.LOCAL_FOLDER, configParams.REMOTE_FOLDER);
+        }
+    
+    }
+
+};

UsesCases/Compares/comparesHelper.js

@@ -0,0 +1,25 @@
+import credentials from "../../../Credentials/credentials.json"  with { type: "json" };
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import { PdfApi } from "../../src/api/api.js";
+
+export const pdfApi = new PdfApi(credentials.id, credentials.key);
+
+export const pdfComparesHelper = {
+    async uploadFile (fileName, localFolder, remoteFolder) {
+        const localFilePath = path.join(localFolder, fileName);
+        const fileData = await fs.readFile(localFilePath);
+        const remoteFilePath = path.join(remoteFolder, fileName);
+        await pdfApi.uploadFile(remoteFilePath, fileData);
+        console.log("Uploaded: " + fileName);
+    },
+                            
+    async downloadResult (fileName, localFolder, remoteFolder) {
+        const remoteFilePath = path.join(remoteFolder, fileName);
+        const changedPdfData = await pdfApi.downloadFile(remoteFilePath);
+        const localFilePath = path.join(localFolder, fileName);
+        await fs.writeFile(localFilePath, changedPdfData.body);
+        console.log("Downloaded: " + localFilePath);
+    },
+
+};

UsesCases/Compares/comparesLaunch.js

@@ -0,0 +1,11 @@
+import { pdfCompares, configParams } from "../Compares/comparePdfDocuments.js";
+
+async function main() {
+    try {
+        await pdfCompares.comparePdfDocuments(configParams.PDF_DOCUMENT_1, configParams.PDF_DOCUMENT_2, configParams.PDF_OUTPUT);
+    } catch (error) {
+        console.error("Error:", error.message);
+    }
+}
+
+await main();

docs/PdfApi.md

@@ -212,6 +212,7 @@ Method | HTTP request | Description
 *PdfApi* | [**postDocumentImageStamps**](PdfApi.md#postDocumentImageStamps) | **POST** /pdf/\{name}/stamps/image | Add document pages image stamps.
 *PdfApi* | [**postDocumentImageStampsPageSpecified**](PdfApi.md#postDocumentImageStampsPageSpecified) | **POST** /pdf/\{name}/stamps/image/pagespecified | Add document image stamps to specified pages.
 *PdfApi* | [**postDocumentPageNumberStamps**](PdfApi.md#postDocumentPageNumberStamps) | **POST** /pdf/\{name}/stamps/pagenumber | Add document page number stamps.
+*PdfApi* | [**postDocumentPagesRotate**](PdfApi.md#postDocumentPagesRotate) | **POST** /pdf/\{name}/rotate | Rotate PDF document.
 *PdfApi* | [**postDocumentTextFooter**](PdfApi.md#postDocumentTextFooter) | **POST** /pdf/\{name}/footer/text | Add document text footer.
 *PdfApi* | [**postDocumentTextHeader**](PdfApi.md#postDocumentTextHeader) | **POST** /pdf/\{name}/header/text | Add document text header.
 *PdfApi* | [**postDocumentTextReplace**](PdfApi.md#postDocumentTextReplace) | **POST** /pdf/\{name}/text/replace | Document's replace text method.
@@ -5237,6 +5238,31 @@ Name | Type | Description  | Notes
 
 [**AsposeResponse**](AsposeResponse.md)
 
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+<a name="postDocumentPagesRotate"></a>
+## **postDocumentPagesRotate**
+> postDocumentPagesRotate(name, rotationAngle, pages, storage, folder, password)
+
+Rotate PDF document.
+
+### Parameters
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+**name** | **string** | The document name. | 
+**rotationAngle** | [**Rotation**](Rotation.md) | Rotation Angle (CKW). Can be 90, 180, 270. | 
+**pages** | **string** | Comma separated list of pages and page ranges. (Example: 1,3-5,8) | 
+**storage** | **string** | The document storage. | [optional]
+**folder** | **string** | The document folder. | [optional]
+**password** | **string** | Base64 encoded password. | [optional]
+
+### Return type
+
+[**AsposeResponse**](AsposeResponse.md)
+
 ### HTTP request headers
 
  - **Content-Type**: application/json

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "asposepdfcloud",
-    "version": "25.5.0",
+    "version": "25.6.0",
     "description": "Aspose.PDF Cloud is a REST API for creating and editing PDF files. Most popular features proposed by Aspose.PDF Cloud: PDF to Word, Convert PDF to Image, Merge PDF, Split PDF, Add Images to PDF, Rotate PDF. It can also be used to convert PDF files to different formats like DOC, HTML, XPS, TIFF and many more. Aspose.PDF Cloud gives you control: create PDFs from scratch or from HTML, XML, template, database, XPS or an image. Render PDFs to image formats such as JPEG, PNG, GIF, BMP, TIFF and many others. Aspose.PDF Cloud helps you manipulate elements of a PDF file like text, annotations, watermarks, signatures, bookmarks, stamps and so on. Its REST API also allows you to manage PDF pages by using features like merging, splitting, and inserting. Add images to a PDF file or convert PDF pages to images.",
     "homepage": "https://products.aspose.cloud/pdf/cloud",
     "author": {

package.json

@@ -13005,6 +13005,83 @@ export class PdfApi {
     }
 
 
+    /**
+     * 
+     * @summary Rotate PDF document.
+     * @param name The document name.
+     * @param rotationAngle Rotation Angle (CKW). Can be 90, 180, 270.
+     * @param pages Comma separated list of pages and page ranges. (Example: 1,3-5,8)
+     * @param storage The document storage.
+     * @param folder The document folder.
+     * @param password Base64 encoded password.
+     */
+    public async postDocumentPagesRotate (name: string, rotationAngle: string, pages: string, storage?: string, folder?: string, password?: string) : Promise<{ response: http.IncomingMessage; body: AsposeResponse;  }> {
+        const localVarPath = this.basePath + '/pdf/{name}/rotate'
+            .replace('{' + 'name' + '}', encodeURIComponent(String(name)).replace('%2F', '/'));
+        let localVarQueryParameters: any = {};
+        let localVarHeaderParams: any = (<any>Object).assign({}, this.defaultHeaders);
+        let localVarFormParams: any = {};
+
+        // verify required parameter 'name' is not null or undefined
+        if (name === null || name === undefined) {
+            throw new Error('Required parameter name was null or undefined when calling postDocumentPagesRotate.');
+        }
+
+        // verify required parameter 'rotationAngle' is not null or undefined
+        if (rotationAngle === null || rotationAngle === undefined) {
+            throw new Error('Required parameter rotationAngle was null or undefined when calling postDocumentPagesRotate.');
+        }
+
+        // verify required parameter 'pages' is not null or undefined
+        if (pages === null || pages === undefined) {
+            throw new Error('Required parameter pages was null or undefined when calling postDocumentPagesRotate.');
+        }
+
+        if (rotationAngle !== undefined && null !== rotationAngle) {
+            localVarQueryParameters['rotationAngle'] = ObjectSerializer.serialize(rotationAngle, "string");
+        }
+
+        if (pages !== undefined && null !== pages) {
+            localVarQueryParameters['pages'] = ObjectSerializer.serialize(pages, "string");
+        }
+
+        if (storage !== undefined && null !== storage) {
+            localVarQueryParameters['storage'] = ObjectSerializer.serialize(storage, "string");
+        }
+
+        if (folder !== undefined && null !== folder) {
+            localVarQueryParameters['folder'] = ObjectSerializer.serialize(folder, "string");
+        }
+
+        if (password !== undefined && null !== password) {
+            localVarQueryParameters['password'] = ObjectSerializer.serialize(password, "string");
+        }
+
+
+        let localVarUseFormData = false;
+        let fileData = null;
+        let localVarRequestOptions: localVarRequest.Options = {
+            method: 'POST',
+            qs: localVarQueryParameters,
+            headers: localVarHeaderParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            json: true,
+        };
+
+        if (Object.keys(localVarFormParams).length) {
+            if (localVarUseFormData) {
+                (<any>localVarRequestOptions).formData = localVarFormParams;
+            } else {
+                localVarRequestOptions.form = localVarFormParams;
+            }
+        }
+        const response = await invokeApiMethod(localVarRequestOptions, this.configuration, false, fileData);
+        const result =  ObjectSerializer.deserialize(response.body, "AsposeResponse");
+        return Promise.resolve({body: result, response});
+    }
+
+
     /**
      * 
      * @summary Add document text footer.

src/api/api.ts

@@ -95,7 +95,7 @@ async function invokeApiMethodInternal(requestOptions: request.Options, confgura
     //headers
     sa.set("User-Agent", "pdf nodejs sdk");
     sa.set("x-aspose-client", "nodejs sdk");  
-    sa.set("x-aspose-client-version", "25.5.0");
+    sa.set("x-aspose-client-version", "25.6.0");
 
     if (!requestOptions.headers) {
         requestOptions.headers = {};

src/requestHelper.ts

@@ -32,6 +32,7 @@ import { Direction } from "../src/models/direction";
 import { PageMode } from "../src/models/pageMode";
 import { PageLayout } from "../src/models/pageLayout";
 import { OrganizeDocumentRequest } from "../src/models/organizeDocumentRequest";
+import { Rotation } from "../src/models/rotation"
 
 var assert = require('assert');
 
@@ -226,4 +227,12 @@ describe("Document Tests", () => {
     });
   });
 
+  describe("PostDocumentPagesRotate Test", () => {    
+    it("should return response with code 200", async () => {
+      const name = "4pages.pdf";
+      await BaseTest.uploadFile(name);
+      const result = await BaseTest.getPdfApi().postDocumentPagesRotate(name, Rotation.on90, "2-3", null, BaseTest.remoteTempFolder)
+      assert.equal(result.response.statusCode, 200);
+    });
+  });
 });