Merge pull request #110 from aspose-pdf-cloud/pdfapps-6679-added-use-cases-for-headers-footers

kaferi · web-flow · commit b88be6d05778 · 2025-02-07T08:52:07.000+02:00
PDFAPPS-6679: added use cases for Headers/Footers
diff --git a/UsesCases/HeaderFooter/appendImageFooter.js b/UsesCases/HeaderFooter/appendImageFooter.js
@@ -0,0 +1,75 @@
+// 1. Load your Application Secret and Key from the JSON file or set credentials in another way
+// 2. Create an object to connect to the Pdf.Cloud API
+// 3. Upload your document file
+// 4. Perform the retreiving link annotattions from Pdf document using getPageLinkAnnotations() function
+// 5. Check result and perform some actions with result.body object
+// 6. Create a new Link Annotation with the required properties
+// 7. Append new Link Annotation to the document using postPageLinkAnnotations() function
+// 8. Perform some action after successful addition
+// All values of variables starting with "YOUR_****" should be replaced by real user values
+
+import credentials from "./credentials.json"  with { type: "json" };
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import { PdfApi } from "asposepdfcloud";
+import { ImageFooter } from "asposepdfcloud/src/models/imageFooter.js";
+import { HorizontalAlignment } from "asposepdfcloud/src/models/horizontalAlignment.js";
+
+const configParams = {
+    LOCAL_FOLDER: "C:\\Samples\\",
+    PDF_DOCUMENT_NAME: "sample.pdf",
+    LOCAL_RESULT_DOCUMENT_NAME: "output_sample.pdf",
+    IMAGE_FOOTER_FILE: "sample.png",
+    PAGE_NUMBER: 2,     // Your document page number...
+};
+
+const pdfApi = new PdfApi(credentials.id, credentials.key);
+
+const pdfHederFooter = {
+    async uploadFile (fileName) {
+        const pdfFileData = await fs.readFile(configParams.LOCAL_FOLDER + fileName);
+        await pdfApi.uploadFile(fileName, pdfFileData);
+    },
+
+    async uploadDocument () {
+        await pdfHederFooter.uploadFile(configParams.PDF_DOCUMENT_NAME);
+    },
+
+    async downloadResult() {
+            const changedPdfData = await pdfApi.downloadFile(configParams.PDF_DOCUMENT_NAME);
+            const filePath = path.join(configParams.LOCAL_FOLDER, configParams.LOCAL_RESULT_DOCUMENT_NAME);
+            await fs.writeFile(filePath, changedPdfData.body);
+            console.log("Downloaded: " + filePath);
+        },
+
+    async addImageFooter () {
+        const imageFooter = new ImageFooter();
+        imageFooter.background = true;
+        imageFooter.value = "TEST FOOTER VALUE";
+        imageFooter.horizontalAlignment = HorizontalAlignment.Center;
+        imageFooter.fileName = configParams.IMAGE_FOOTER_FILE;
+        imageFooter.width = 24;
+        imageFooter.height = 24;
+
+        const resultLinks = await pdfApi.postDocumentImageFooter(configParams.PDF_DOCUMENT_NAME, imageFooter);
+
+        if (resultLinks.body.code == 200) {
+            return resultLinks.body;
+        }
+        else
+            throw new Error("Unexpected error : can't append Text Header!");
+    },
+}
+
+async function main() {
+    try {
+        await pdfHederFooter.uploadDocument();
+        await pdfHederFooter.uploadFile(configParams.IMAGE_FOOTER_FILE);
+        await pdfHederFooter.addImageFooter();
+        await pdfHederFooter.downloadResult();
+    } catch (error) {
+        console.error("Error:", error.message);
+    }
+}
+
+main();
diff --git a/UsesCases/HeaderFooter/appendImageHeader.js b/UsesCases/HeaderFooter/appendImageHeader.js
@@ -0,0 +1,75 @@
+// 1. Load your Application Secret and Key from the JSON file or set credentials in another way
+// 2. Create an object to connect to the Pdf.Cloud API
+// 3. Upload your document file
+// 4. Perform the retreiving link annotattions from Pdf document using getPageLinkAnnotations() function
+// 5. Check result and perform some actions with result.body object
+// 6. Create a new Link Annotation with the required properties
+// 7. Append new Link Annotation to the document using postPageLinkAnnotations() function
+// 8. Perform some action after successful addition
+// All values of variables starting with "YOUR_****" should be replaced by real user values
+
+import credentials from "./credentials.json"  with { type: "json" };    // json-file in this format: { "id": "*****", "key": "*******" }
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import { PdfApi } from "asposepdfcloud";
+import { ImageHeader } from "asposepdfcloud/src/models/imageHeader.js";
+import { HorizontalAlignment } from "asposepdfcloud/src/models/horizontalAlignment.js";
+
+const configParams = {
+    LOCAL_FOLDER: "C:\\Samples\\",
+    PDF_DOCUMENT_NAME: "sample.pdf",
+    LOCAL_RESULT_DOCUMENT_NAME: "output_sample.pdf",
+    IMAGE_HEADER_FILE: "sample.png",
+    PAGE_NUMBER: 2,     // Your document page number...
+};
+
+const pdfApi = new PdfApi(credentials.id, credentials.key);
+
+const pdfHederFooter = {
+    async uploadFile (fileName) {
+        const pdfFileData = await fs.readFile(configParams.LOCAL_FOLDER + fileName);
+        await pdfApi.uploadFile(fileName, pdfFileData);
+    },
+
+    async uploadDocument () {
+        await pdfHederFooter.uploadFile(configParams.PDF_DOCUMENT_NAME);
+    },
+
+    async downloadResult() {
+        const changedPdfData = await pdfApi.downloadFile(configParams.PDF_DOCUMENT_NAME);
+        const filePath = path.join(configParams.LOCAL_FOLDER, configParams.LOCAL_RESULT_DOCUMENT_NAME);
+        await fs.writeFile(filePath, changedPdfData.body);
+        console.log("Downloaded: " + filePath);
+    },
+
+    async adddImageHeader () {
+        const imageHeader = new ImageHeader();
+        imageHeader.background = true;
+        imageHeader.value = "TEST HEADER VALUE";
+        imageHeader.horizontalAlignment = HorizontalAlignment.Center;
+        imageHeader.fileName = configParams.IMAGE_HEADER_FILE;
+        imageHeader.width = 24;
+        imageHeader.height = 24;
+
+        const resultLinks = await pdfApi.postDocumentImageHeader(configParams.PDF_DOCUMENT_NAME, imageHeader);
+
+        if (resultLinks.body.code == 200) {
+            return resultLinks.body;
+        }
+        else
+            throw new Error("Unexpected error : can't append Text Header!");
+    },
+}
+
+async function main() {
+    try {
+        await pdfHederFooter.uploadDocument();
+        await pdfHederFooter.uploadFile(configParams.IMAGE_HEADER_FILE);
+        await pdfHederFooter.adddImageHeader();
+        await pdfHederFooter.downloadResult();
+    } catch (error) {
+        console.error("Error:", error.message);
+    }
+}
+
+main();
diff --git a/UsesCases/HeaderFooter/appendTextFooter.js b/UsesCases/HeaderFooter/appendTextFooter.js
@@ -0,0 +1,61 @@
+// 1. Load your Application Secret and Key from the JSON file or set credentials in another way
+// 2. Create an object to connect to the Pdf.Cloud API
+// 3. Upload your document file
+// 4. Perform the retreiving link annotattions from Pdf document using getPageLinkAnnotations() function
+// 5. Check result and perform some actions with result.body object
+// 6. Create a new Link Annotation with the required properties
+// 7. Append new Link Annotation to the document using postPageLinkAnnotations() function
+// 8. Perform some action after successful addition
+// All values of variables starting with "YOUR_****" should be replaced by real user values
+
+import credentials from "./credentials.json"  with { type: "json" };
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import { PdfApi } from "asposepdfcloud";
+import { TextFooter } from "asposepdfcloud/src/models/textFooter.js";
+import { HorizontalAlignment } from "asposepdfcloud/src/models/horizontalAlignment.js";
+
+const configParams = {
+    LOCAL_FOLDER: "C:\\Samples\\",
+    PDF_DOCUMENT_NAME: "sample.pdf",
+    LOCAL_RESULT_DOCUMENT_NAME: "output_sample.pdf",
+    FOOTER_VALUE: "New Footer Value",
+};
+
+const pdfApi = new PdfApi(credentials.id, credentials.key);
+
+const pdfHederFooter = {
+    async uploadDocument() {
+        const pdfFilePath = path.join(configParams.LOCAL_FOLDER, configParams.PDF_DOCUMENT_NAME);
+        const pdfFileData = await fs.readFile(pdfFilePath);
+        await pdfApi.uploadFile(configParams.PDF_DOCUMENT_NAME, pdfFileData);
+    },
+
+    async downloadResult() {
+        const changedPdfData = await pdfApi.downloadFile(configParams.PDF_DOCUMENT_NAME);
+        const filePath = path.join(configParams.LOCAL_FOLDER, configParams.LOCAL_RESULT_DOCUMENT_NAME);
+        await fs.writeFile(filePath, changedPdfData.body);
+        console.log("Downloaded: " + filePath);
+    },
+
+    async adddTextFooter () {
+        const textFooter = new TextFooter();
+        textFooter.background = true;
+        textFooter.value = configParams.FOOTER_VALUE;
+        textFooter.horizontalAlignment = HorizontalAlignment.Center;
+
+        await pdfApi.postDocumentTextFooter(configParams.PDF_DOCUMENT_NAME, textFooter);
+    },
+}
+
+async function main() {
+    try {
+        await pdfHederFooter.uploadDocument();
+        await pdfHederFooter.adddTextFooter();
+        await pdfHederFooter.downloadResult();
+    } catch (error) {
+        console.error("Error:", error.message);
+    }
+}
+
+main();
diff --git a/UsesCases/HeaderFooter/appendTextHeader.js b/UsesCases/HeaderFooter/appendTextHeader.js
@@ -0,0 +1,64 @@
+// 1. Load your Application Secret and Key from the JSON file or set credentials in another way
+// 2. Create an object to connect to the Pdf.Cloud API
+// 3. Upload your document file
+// 4. Perform the retreiving link annotattions from Pdf document using getPageLinkAnnotations() function
+// 5. Check result and perform some actions with result.body object
+// 6. Create a new Link Annotation with the required properties
+// 7. Append new Link Annotation to the document using postPageLinkAnnotations() function
+// 8. Perform some action after successful addition
+// All values of variables starting with "YOUR_****" should be replaced by real user values
+
+import credentials from "./credentials.json"  with { type: "json" };
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import { PdfApi } from "asposepdfcloud";
+import { TextHeader } from "asposepdfcloud/src/models/textHeader.js";
+import { HorizontalAlignment } from "asposepdfcloud/src/models/horizontalAlignment.js";
+
+const configParams = {
+    LOCAL_FOLDER: "C:\\Samples\\",
+    PDF_DOCUMENT_NAME: "sample.pdf",
+    LOCAL_RESULT_DOCUMENT_NAME: "output_sample.pdf",
+    HEADER_VALUE: "New Heder Value",
+};
+
+const pdfApi = new PdfApi(credentials.id, credentials.key);
+
+const pdfHederFooter = {
+    async uploadFile (fileName) {
+        const pdfFileData = await fs.readFile(configParams.LOCAL_FOLDER + fileName);
+        await pdfApi.uploadFile(fileName, pdfFileData);
+    },
+
+    async downloadResult() {
+        const changedPdfData = await pdfApi.downloadFile(configParams.PDF_DOCUMENT_NAME);
+        const filePath = path.join(configParams.LOCAL_FOLDER, configParams.LOCAL_RESULT_DOCUMENT_NAME);
+        await fs.writeFile(filePath, changedPdfData.body);
+        console.log("Downloaded: " + filePath);
+    },
+
+    async uploadDocument () {
+        await pdfHederFooter.uploadFile(configParams.PDF_DOCUMENT_NAME);
+    },
+
+    async adddTextHeader () {
+        const textHeader = new TextHeader();
+        textHeader.background = true;
+        textHeader.value = configParams.HEADER_VALUE;
+        textHeader.horizontalAlignment = HorizontalAlignment.Center;
+
+        await pdfApi.postDocumentTextHeader(configParams.PDF_DOCUMENT_NAME, textHeader);
+    },
+}
+
+async function main() {
+    try {
+        await pdfHederFooter.uploadDocument();
+        await pdfHederFooter.adddTextHeader();
+        await pdfHederFooter.downloadResult();
+    } catch (error) {
+        console.error("Error:", error.message);
+    }
+}
+
+main();
