@pdftron/pdfnet-node-samples 9.4.2 → 9.5.0-beta

package/samples/BookmarkTest/NODEJS/BookmarkTest.js

@@ -0,0 +1,220 @@
+//---------------------------------------------------------------------------------------
+// Copyright (c) 2001-2021 by PDFTron Systems Inc. All Rights Reserved.
+// Consult legal.txt regarding legal and license information.
+//---------------------------------------------------------------------------------------
+
+//-----------------------------------------------------------------------------------------
+// The sample code illustrates how to read and edit existing outline items and create 
+// new bookmarks using the high-level API.
+//-----------------------------------------------------------------------------------------
+
+const { PDFNet } = require('../../../lib/pdfnet.js');
+const PDFTronLicense = require('../../LicenseKey/NODEJS/LicenseKey');
+
+((exports) => {
+
+  exports.runBookmarkTest = () => {
+
+    const getIndent = async (item) => {
+      const ident = (await item.getIndent()) - 1;
+      let str = '';
+      for (let i = 0; i < ident; ++i) {
+        str += '  ';
+      }
+      return str;
+    };
+
+    // Prints out the outline tree to the standard output
+    const printOutlineTree = async (item) => {
+      for (; item != null; item = await item.getNext()) {
+        const indentString = await getIndent(item);
+        const titleString = await item.getTitle();
+
+        const actionString = indentString + (await item.isOpen() ? '- ' : '+ ') + titleString + ' ACTION -> ';
+
+        // Print Action
+        const action = await item.getAction();
+        if (await action.isValid()) {
+          const actionType = await action.getType();
+          if (actionType === PDFNet.Action.Type.e_GoTo) {
+            const dest = await action.getDest();
+            if (await dest.isValid()) {
+              const page = await dest.getPage();
+              console.log(actionString + 'GoTo Page #' + (await page.getIndex()));
+            }
+          } else {
+            console.log(actionString + 'Not a "GoTo" action');
+          }
+        } else {
+          console.log(actionString + 'NULL');
+        }
+
+        if (await item.hasChildren()) {
+          await printOutlineTree(await item.getFirstChild());
+        }
+      }
+    };
+
+    const main = async () => {
+      // Relative path to the folder containing test files.
+      const inputPath = '../../TestFiles/';
+      const outputPath = inputPath + 'Output/';
+      
+      // The following example illustrates how to create and edit the outline tree
+      // using high-level Bookmark methods.
+      try {
+        let doc = await PDFNet.PDFDoc.createFromFilePath(inputPath + 'numbered.pdf');
+        doc.initSecurityHandler();
+
+        // Lets first create the root bookmark items.
+        const red = await PDFNet.Bookmark.create(doc, 'Red');
+        const green = await PDFNet.Bookmark.create(doc, 'Green');
+        const blue = await PDFNet.Bookmark.create(doc, 'Blue');
+
+        doc.addRootBookmark(red);
+        doc.addRootBookmark(green);
+        doc.addRootBookmark(blue);
+
+        // You can also add new root bookmarks using Bookmark.addNext("...")
+        blue.addNewNext('foo');
+        blue.addNewNext('bar');
+
+        // We can now associate new bookmarks with page destinations:
+
+        // The following example creates an 'explicit' destination (see
+        // section '8.2.1 Destinations' in PDF Reference for more details)
+        const redIter = await doc.getPageIterator(1);
+        const redCurrpage = await redIter.current();
+        const redDest = await PDFNet.Destination.createFit(redCurrpage);
+        red.setAction(await PDFNet.Action.createGoto(redDest));
+
+        // Create an explicit destination to the first green page in the document
+        const tenthPage = await doc.getPage(10);
+        const greenDest = await PDFNet.Destination.createFit(tenthPage);
+        green.setAction(await PDFNet.Action.createGoto(greenDest));
+
+        // The following example creates a 'named' destination (see
+        // section '8.2.1 Destinations' in PDF Reference for more details)
+        // Named destinations have certain advantages over explicit destinations.
+        const key = 'blue1';
+        const nineteenthPage = await doc.getPage(19);
+        const blueDest = await PDFNet.Destination.createFit(nineteenthPage);
+        const blueAction = await PDFNet.Action.createGotoWithKey(key, blueDest); // TODO FIND FIX
+
+        blue.setAction(blueAction);
+
+        // We can now add children Bookmarks subRed1 instanceof Promise
+        const subRed1 = await red.addNewChild('Red - Page 1');
+        subRed1.setAction(await PDFNet.Action.createGoto(await PDFNet.Destination.createFit(await doc.getPage(1))));
+        const subRed2 = await red.addNewChild('Red - Page 2');
+        subRed2.setAction(await PDFNet.Action.createGoto(await PDFNet.Destination.createFit(await doc.getPage(2))));
+        const subRed3 = await red.addNewChild('Red - Page 3');
+        subRed3.setAction(await PDFNet.Action.createGoto(await PDFNet.Destination.createFit(await doc.getPage(3))));
+        const subRed4 = await subRed3.addNewChild('Red - Page 4');
+        subRed4.setAction(await PDFNet.Action.createGoto(await PDFNet.Destination.createFit(await doc.getPage(4))));
+        const subRed5 = await subRed3.addNewChild('Red - Page 5');
+        subRed5.setAction(await PDFNet.Action.createGoto(await PDFNet.Destination.createFit(await doc.getPage(5))));
+        const subRed6 = await subRed3.addNewChild('Red - Page 6');
+        subRed6.setAction(await PDFNet.Action.createGoto(await PDFNet.Destination.createFit(await doc.getPage(6))));
+
+        // Example of how to find and delete a bookmark by title text.
+        const firstbookmark = await doc.getFirstBookmark();
+        const foo = await firstbookmark.find('foo');
+        if (await foo.isValid()) {
+          foo.delete();
+        } else {
+          console.log('Bookmark foo is invalid');
+        }
+        const bar = await firstbookmark.find('bar');
+        if (await bar.isValid()) {
+          bar.delete();
+        } else {
+          console.log('Bookmark bar is invalid');
+        }
+
+        // Adding color to Bookmarks. Color and other formatting can help readers
+        // get around more easily in large PDF documents.
+        red.setColor(1, 0, 0);
+        green.setColor(0, 1, 0);
+        green.setFlags(2); // set bold font
+        blue.setColor(0, 0, 1);
+        blue.setFlags(3); // set bold and italic
+
+        await doc.save(outputPath + 'bookmark.pdf', 0);
+        console.log('Done. Result saved in bookmark.pdf');
+      } catch (err) {
+        console.log(err);
+      }
+
+        // The following example illustrates how to traverse the outline tree using
+        // Bookmark navigation methods: Bookmark.getNext(), Bookmark.getPrev(),
+        // Bookmark.getFirstChild () and Bookmark.getLastChild ().
+      try {
+        // Open the document that was saved in the previous code sample
+        const doc = await PDFNet.PDFDoc.createFromFilePath(outputPath + 'bookmark.pdf');
+        doc.initSecurityHandler();
+
+        const root = await doc.getFirstBookmark();
+        await printOutlineTree(root);
+
+        console.log('Done.');
+      } catch (err) {
+        console.log(err);
+      }
+
+        // The following example illustrates how to create a Bookmark to a page
+        // in a remote document. A remote go-to action is similar to an ordinary
+        // go-to action, but jumps to a destination in another PDF file instead
+        // of the current file. See Section 8.5.3 'Remote Go-To Actions' in PDF
+        // Reference Manual for details.
+
+        try {
+          // Open the document that was saved in the previous code sample
+        const doc = await PDFNet.PDFDoc.createFromFilePath(outputPath + 'bookmark.pdf');
+        doc.initSecurityHandler();
+
+        // Create file specification (the file referred to by the remote bookmark)
+        const fileSpec = await doc.createIndirectDict();
+        fileSpec.putName('Type', 'Filespec');
+        fileSpec.putString('F', 'bookmark.pdf');
+        const spec = await PDFNet.FileSpec.createFromObj(fileSpec);
+        const gotoRemote = await PDFNet.Action.createGotoRemoteSetNewWindow(spec, 5, true);
+
+        const remoteBookmark1 = await PDFNet.Bookmark.create(doc, 'REMOTE BOOKMARK 1');
+        remoteBookmark1.setAction(gotoRemote);
+        doc.addRootBookmark(remoteBookmark1);
+
+        // Create another remote bookmark, but this time using the low-level SDF/Cos API.
+        // Create a remote action
+        const remoteBookmark2 = await PDFNet.Bookmark.create(doc, 'REMOTE BOOKMARK 2');
+        doc.addRootBookmark(remoteBookmark2);
+
+        const gotoR = await (await remoteBookmark2.getSDFObj()).putDict('A');
+        {
+          gotoR.putName('S', 'GoToR'); // Set action type
+          gotoR.putBool('NewWindow', true);
+
+          // Set the file specification
+          gotoR.put('F', fileSpec);
+
+          // jump to the first page. Note that pages are indexed from 0.
+          const dest = await gotoR.putArray('D');
+          dest.pushBackNumber(9);
+          dest.pushBackName('Fit');
+        }
+
+        await doc.save(inputPath + 'Output/bookmark_remote.pdf', PDFNet.SDFDoc.SaveOptions.e_linearized);
+
+        console.log('Done. Result saved in bookmark_remote.pdf');
+      } catch (err) {
+        console.log(err);
+      }
+    };
+    PDFNet.runWithCleanup(main, PDFTronLicense.Key).catch(function (error) {
+      console.log('Error: ' + JSON.stringify(error));
+    }).then(function () { return PDFNet.shutdown(); });
+  };
+  exports.runBookmarkTest();
+})(exports);
+// eslint-disable-next-line spaced-comment
+//# sourceURL=BookmarkTest.js

package/samples/BookmarkTest/NODEJS/RunTest.sh

@@ -0,0 +1,2 @@
+#!/bin/sh
+node BookmarkTest.js

package/samples/CAD2PDFTest/CAD2PDFTest.js

@@ -1,80 +1,80 @@
-//---------------------------------------------------------------------------------------
-// Copyright (c) 2001-2022 by PDFTron Systems Inc. All Rights Reserved.
-// Consult legal.txt regarding legal and license information.
-//---------------------------------------------------------------------------------------
-
-
-//---------------------------------------------------------------------------------------
-// The following sample illustrates how to convert CAD documents to PDF format 
-// 
-// The CAD module is an optional PDFNet Add-on that can be used to convert CAD
-// documents into PDF documents
-//
-// The PDFTron SDK CAD module can be downloaded from http://www.pdftron.com/
-//---------------------------------------------------------------------------------------
-
-
-const { PDFNet } = require('@pdftron/pdfnet-node');
-const PDFTronLicense = require('../LicenseKey/LicenseKey');
-
-((exports) => {
-  'use strict';
-
-  exports.runCAD2PDFTest = () => {
-    const IsRVTFile = function (inputFile) {
-      let rvt_input = false;
-      if (inputFile.length > 2) {
-        if (inputFile.substr(inputFile.length - 3, 3) === 'rvt') {
-          rvt_input = true;
-        }
-      }
-      return rvt_input;
-    }
-
-    const main = async () => {
-      try {
-        await PDFNet.addResourceSearchPath('../../lib/');
-        if (!(await PDFNet.CADModule.isModuleAvailable())) {
-          console.log('\nUnable to run CAD2PDFTest: PDFTron SDK CAD module not available.');
-          console.log('---------------------------------------------------------------');
-          console.log('The CAD module is an optional add-on, available for download');
-          console.log('at http://www.pdftron.com/. If you have already downloaded this');
-          console.log('module, ensure that the SDK is able to find the required files');
-          console.log('using the PDFNet.addResourceSearchPath() function.\n');
-
-          return;
-        }
-
-        // Relative path to the folder containing test files.
-        const inputPath = '../TestFiles/CAD/';
-        const outputPath = '../TestFiles/Output/';
-
-        const input_file_name = 'construction drawings color-28.05.18.dwg';
-        const output_file_name = 'construction drawings color-28.05.18.pdf';
-
-        const doc = await PDFNet.PDFDoc.create();
-        doc.initSecurityHandler();
-
-        if (IsRVTFile(input_file_name)) {
-          const opts = new PDFNet.Convert.CADConvertOptions();
-          opts.setPageWidth(800);
-          opts.setPageHeight(600);
-          opts.setRasterDPI(150);
-          await PDFNet.Convert.fromCAD(doc, inputPath + input_file_name, opts);
-        } else {
-          await PDFNet.Convert.fromCAD(doc, inputPath + input_file_name);
-        }
-        const outputFile = outputPath + output_file_name;
-        await doc.save(outputFile, PDFNet.SDFDoc.SaveOptions.e_linearized);
-      } catch (err) {
-        console.log(err);
-      }
-    };
-    PDFNet.runWithCleanup(main, PDFTronLicense.Key).catch(function(error) {
-      console.log('Error: ' + JSON.stringify(error));
-    }).then(function(){ return PDFNet.shutdown(); });
-  };
-  exports.runCAD2PDFTest();
-})(exports);
-// eslint-disable-next-line spaced-comment
+//---------------------------------------------------------------------------------------
+// Copyright (c) 2001-2023 by PDFTron Systems Inc. All Rights Reserved.
+// Consult legal.txt regarding legal and license information.
+//---------------------------------------------------------------------------------------
+
+
+//---------------------------------------------------------------------------------------
+// The following sample illustrates how to convert CAD documents to PDF format 
+// 
+// The CAD module is an optional PDFNet Add-on that can be used to convert CAD
+// documents into PDF documents
+//
+// The PDFTron SDK CAD module can be downloaded from http://www.pdftron.com/
+//---------------------------------------------------------------------------------------
+
+
+const { PDFNet } = require('@pdftron/pdfnet-node');
+const PDFTronLicense = require('../LicenseKey/LicenseKey');
+
+((exports) => {
+  'use strict';
+
+  exports.runCAD2PDFTest = () => {
+    const IsRVTFile = function (inputFile) {
+      let rvt_input = false;
+      if (inputFile.length > 2) {
+        if (inputFile.substr(inputFile.length - 3, 3) === 'rvt') {
+          rvt_input = true;
+        }
+      }
+      return rvt_input;
+    }
+
+    const main = async () => {
+      try {
+        await PDFNet.addResourceSearchPath('../../lib/');
+        if (!(await PDFNet.CADModule.isModuleAvailable())) {
+          console.log('\nUnable to run CAD2PDFTest: PDFTron SDK CAD module not available.');
+          console.log('---------------------------------------------------------------');
+          console.log('The CAD module is an optional add-on, available for download');
+          console.log('at http://www.pdftron.com/. If you have already downloaded this');
+          console.log('module, ensure that the SDK is able to find the required files');
+          console.log('using the PDFNet.addResourceSearchPath() function.\n');
+
+          return;
+        }
+
+        // Relative path to the folder containing test files.
+        const inputPath = '../TestFiles/CAD/';
+        const outputPath = '../TestFiles/Output/';
+
+        const input_file_name = 'construction drawings color-28.05.18.dwg';
+        const output_file_name = 'construction drawings color-28.05.18.pdf';
+
+        const doc = await PDFNet.PDFDoc.create();
+        doc.initSecurityHandler();
+
+        if (IsRVTFile(input_file_name)) {
+          const opts = new PDFNet.Convert.CADConvertOptions();
+          opts.setPageWidth(800);
+          opts.setPageHeight(600);
+          opts.setRasterDPI(150);
+          await PDFNet.Convert.fromCAD(doc, inputPath + input_file_name, opts);
+        } else {
+          await PDFNet.Convert.fromCAD(doc, inputPath + input_file_name);
+        }
+        const outputFile = outputPath + output_file_name;
+        await doc.save(outputFile, PDFNet.SDFDoc.SaveOptions.e_linearized);
+      } catch (err) {
+        console.log(err);
+      }
+    };
+    PDFNet.runWithCleanup(main, PDFTronLicense.Key).catch(function(error) {
+      console.log('Error: ' + JSON.stringify(error));
+    }).then(function(){ return PDFNet.shutdown(); });
+  };
+  exports.runCAD2PDFTest();
+})(exports);
+// eslint-disable-next-line spaced-comment
 //# sourceURL=CAD2PDFTest.js

package/samples/CAD2PDFTest/NODEJS/CAD2PDFTest.js

@@ -0,0 +1,80 @@
+//---------------------------------------------------------------------------------------
+// Copyright (c) 2001-2021 by PDFTron Systems Inc. All Rights Reserved.
+// Consult legal.txt regarding legal and license information.
+//---------------------------------------------------------------------------------------
+
+
+//---------------------------------------------------------------------------------------
+// The following sample illustrates how to convert CAD documents to PDF format 
+// 
+// The CAD module is an optional PDFNet Add-on that can be used to convert CAD
+// documents into PDF documents
+//
+// The PDFTron SDK CAD module can be downloaded from http://www.pdftron.com/
+//---------------------------------------------------------------------------------------
+
+
+const { PDFNet } = require('../../../lib/pdfnet.js');
+const PDFTronLicense = require('../../LicenseKey/NODEJS/LicenseKey');
+
+((exports) => {
+  'use strict';
+
+  exports.runCAD2PDFTest = () => {
+    const IsRVTFile = function (inputFile) {
+      let rvt_input = false;
+      if (inputFile.length > 2) {
+        if (inputFile.substr(inputFile.length - 3, 3) === 'rvt') {
+          rvt_input = true;
+        }
+      }
+      return rvt_input;
+    }
+
+    const main = async () => {
+      try {
+        await PDFNet.addResourceSearchPath('../../../lib/');
+        if (!(await PDFNet.CADModule.isModuleAvailable())) {
+          console.log('\nUnable to run CAD2PDFTest: PDFTron SDK CAD module not available.');
+          console.log('---------------------------------------------------------------');
+          console.log('The CAD module is an optional add-on, available for download');
+          console.log('at http://www.pdftron.com/. If you have already downloaded this');
+          console.log('module, ensure that the SDK is able to find the required files');
+          console.log('using the PDFNet.addResourceSearchPath() function.\n');
+
+          return;
+        }
+
+        // Relative path to the folder containing test files.
+        const inputPath = '../../TestFiles/CAD/';
+        const outputPath = '../../TestFiles/Output/';
+
+        const input_file_name = 'construction drawings color-28.05.18.dwg';
+        const output_file_name = 'construction drawings color-28.05.18.pdf';
+
+        const doc = await PDFNet.PDFDoc.create();
+        doc.initSecurityHandler();
+
+        if (IsRVTFile(input_file_name)) {
+          const opts = new PDFNet.Convert.CADConvertOptions();
+          opts.setPageWidth(800);
+          opts.setPageHeight(600);
+          opts.setRasterDPI(150);
+          await PDFNet.Convert.fromCAD(doc, inputPath + input_file_name, opts);
+        } else {
+          await PDFNet.Convert.fromCAD(doc, inputPath + input_file_name);
+        }
+        const outputFile = outputPath + output_file_name;
+        await doc.save(outputFile, PDFNet.SDFDoc.SaveOptions.e_linearized);
+      } catch (err) {
+        console.log(err);
+      }
+    };
+    PDFNet.runWithCleanup(main, PDFTronLicense.Key).catch(function(error) {
+      console.log('Error: ' + JSON.stringify(error));
+    }).then(function(){ return PDFNet.shutdown(); });
+  };
+  exports.runCAD2PDFTest();
+})(exports);
+// eslint-disable-next-line spaced-comment
+//# sourceURL=CAD2PDFTest.js

package/samples/CAD2PDFTest/NODEJS/RunTest.sh

@@ -0,0 +1,2 @@
+#!/bin/sh
+node CAD2PDFTest.js

package/samples/ContentReplacerTest/ContentReplacerTest.js

@@ -1,5 +1,5 @@
 //---------------------------------------------------------------------------------------
-// Copyright (c) 2001-2022 by PDFTron Systems Inc. All Rights Reserved.
+// Copyright (c) 2001-2023 by PDFTron Systems Inc. All Rights Reserved.
 // Consult legal.txt regarding legal and license information.
 //---------------------------------------------------------------------------------------
 

package/samples/ContentReplacerTest/NODEJS/ContentReplacerTest.js

@@ -0,0 +1,75 @@
+//---------------------------------------------------------------------------------------
+// Copyright (c) 2001-2021 by PDFTron Systems Inc. All Rights Reserved.
+// Consult legal.txt regarding legal and license information.
+//---------------------------------------------------------------------------------------
+
+
+const { PDFNet } = require('../../../lib/pdfnet.js');
+const PDFTronLicense = require('../../LicenseKey/NODEJS/LicenseKey');
+
+((exports) => {
+
+  exports.runContentReplacer = () => {
+
+    const main = async() => {
+      const inputPath = '../../TestFiles/';
+      const outputPath = inputPath + 'Output/';
+
+      try {
+        const inputFilename = 'BusinessCardTemplate.pdf';
+        const outputFilename = 'BusinessCard.pdf';
+
+        const doc = await PDFNet.PDFDoc.createFromFilePath(inputPath + inputFilename);
+        doc.initSecurityHandler();
+
+        const replacer = await PDFNet.ContentReplacer.create();
+        const page = await doc.getPage(1);
+        const img = await PDFNet.Image.createFromFile(doc, inputPath + 'peppers.jpg');
+
+        const region = await page.getMediaBox();
+        const replace = await img.getSDFObj();
+        await replacer.addImage(region, replace);
+        await replacer.addString('NAME', 'John Smith');
+        await replacer.addString('QUALIFICATIONS', 'Philosophy Doctor');
+        await replacer.addString('JOB_TITLE', 'Software Developer');
+        await replacer.addString('ADDRESS_LINE1', '#100 123 Software Rd');
+        await replacer.addString('ADDRESS_LINE2', 'Vancouver, BC');
+        await replacer.addString('PHONE_OFFICE', '604-730-8989');
+        await replacer.addString('PHONE_MOBILE', '604-765-4321');
+        await replacer.addString('EMAIL', 'info@pdftron.com');
+        await replacer.addString('WEBSITE_URL', 'http://www.pdftron.com');
+        await replacer.process(page);
+
+        await doc.save(outputPath + outputFilename, PDFNet.SDFDoc.SaveOptions.e_remove_unused);
+
+        console.log('Done. Result saved in ' + outputFilename);
+      } catch (err) {
+        console.log(err);
+      }
+      try {
+        const inputFilename = 'newsletter.pdf';
+        const outputFilename = 'ContentReplaced.pdf';
+
+        const doc = await PDFNet.PDFDoc.createFromFilePath(inputPath + inputFilename);
+        doc.initSecurityHandler();
+
+        const replacer = await PDFNet.ContentReplacer.create();
+        const page = await doc.getPage(1);
+        const region = await page.getMediaBox();
+        await replacer.addText(region, 'hello hello hello hello hello hello hello hello hello hello');
+        await replacer.process(page);
+
+        await doc.save(outputPath + outputFilename, PDFNet.SDFDoc.SaveOptions.e_remove_unused);
+
+        console.log('Done. Result saved in ' + outputFilename);
+      } catch (err) {
+        console.log(err);
+      }
+      console.log('Done.');
+    };
+    PDFNet.runWithCleanup(main, PDFTronLicense.Key).catch(function(error){console.log('Error: ' + JSON.stringify(error));}).then(function(){return PDFNet.shutdown();});
+  };
+  exports.runContentReplacer();
+})(exports);
+// eslint-disable-next-line spaced-comment
+//# sourceURL=ContentReplacerTest.js

package/samples/ContentReplacerTest/NODEJS/RunTest.sh

@@ -0,0 +1,2 @@
+#!/bin/sh
+node ContentReplacerTest.js