@pdftron/pdfnet-node-samples 9.4.2 → 9.5.0

package/samples/OCRTest/OCRTest.js

@@ -1,235 +1,235 @@
-//---------------------------------------------------------------------------------------
-// Copyright (c) 2001-2022 by PDFTron Systems Inc. All Rights Reserved.
-// Consult legal.txt regarding legal and license information.
-//---------------------------------------------------------------------------------------
-
-
-const { PDFNet } = require('@pdftron/pdfnet-node');
-const PDFTronLicense = require('../LicenseKey/LicenseKey');
-
-((exports) => {
-  'use strict';
-
-  //---------------------------------------------------------------------------------------
-  // The following sample illustrates how to use OCR module
-  //---------------------------------------------------------------------------------------
-  exports.runOCRTest = () => {
-    const main = async () => {
-      try {
-
-        PDFNet.addResourceSearchPath('../../lib/');
-
-        const useIRIS = await PDFNet.OCRModule.isIRISModuleAvailable();
-        if (!(await PDFNet.OCRModule.isModuleAvailable())) {
-          console.log('\nUnable to run OCRTest: PDFTron SDK OCR module not available.');
-          console.log('---------------------------------------------------------------');
-          console.log('The OCR 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 input_path = '../TestFiles/OCR/';
-        const output_path = '../TestFiles/Output/';
-
-        //--------------------------------------------------------------------------------
-        // Example 1) Process image without specifying options, default language - English - is used
-        try {
-
-          // A) Setup empty destination doc
-          const doc = await PDFNet.PDFDoc.create();
-          
-          await doc.initSecurityHandler();
-
-          const opts = new PDFNet.OCRModule.OCROptions();
-          if(useIRIS) opts.setOCREngine('iris');
-
-          // B) Run OCR on the .png with options
-          await PDFNet.OCRModule.imageToPDF(doc, input_path + 'psychomachia_excerpt.png', opts);
-
-          // C) check the result
-          await doc.save(output_path + 'psychomachia_excerpt.pdf', 0);
-
-          console.log('Example 1: psychomachia_excerpt.png');
-
-        } catch (err) {
-          console.log(err);
-        }
-
-        //--------------------------------------------------------------------------------
-        // Example 2) Process document using multiple languages
-        try {
-          // A) Setup empty destination doc
-          const doc = await PDFNet.PDFDoc.create();
-          await doc.initSecurityHandler();
-
-          // B) Setup options with multiple target languages, English will always be considered as secondary language
-          const opts = new PDFNet.OCRModule.OCROptions();
-          if(useIRIS) opts.setOCREngine('iris');
-          opts.addLang('rus');
-          opts.addLang('deu');
-
-          // C) Run OCR on the .jpg with options
-          await PDFNet.OCRModule.imageToPDF(doc, input_path + 'multi_lang.jpg', opts);
-
-          // D) check the result
-          await doc.save(output_path + 'multi_lang.pdf', 0);
-
-          console.log('Example 2: multi_lang.jpg');
-        } catch (err) {
-          console.log(err);
-        }
-
-        //--------------------------------------------------------------------------------
-        // Example 3) Process a .pdf specifying a language - German - and ignore zone comprising a sidebar image 
-        try {
-          // A) Open the .pdf document
-          const doc = await PDFNet.PDFDoc.createFromFilePath(input_path + 'german_kids_song.pdf');
-          doc.initSecurityHandler();
-
-          // B) Setup options with a single language and an ignore zone
-          const opts = new PDFNet.OCRModule.OCROptions();
-          if(useIRIS) opts.setOCREngine('iris');
-          opts.addLang('deu');
-
-          const ignore_zones = [];
-          ignore_zones.push(new PDFNet.Rect(424, 163, 493, 730));
-          opts.addIgnoreZonesForPage(ignore_zones, 1);
-
-          // C) Run OCR on the .pdf with options
-          await PDFNet.OCRModule.processPDF(doc, opts);
-
-          // D) check the result
-          await doc.save(output_path + 'german_kids_song.pdf', 0);
-
-          console.log('Example 3: german_kids_song.pdf');
-        } catch (err) {
-          console.log(err);
-        }
-
-        //--------------------------------------------------------------------------------
-        // Example 4) Process multipage tiff with text/ignore zones specified for each page, optionally provide English as the target language
-        try {
-          // A) Setup empty destination doc
-          const doc = await PDFNet.PDFDoc.create();
-          await doc.initSecurityHandler();
-
-          // B) Setup options with a single language plus text/ignore zones
-          const opts = new PDFNet.OCRModule.OCROptions();
-          if(useIRIS) opts.setOCREngine('iris');
-          opts.addLang('eng');
-
-          var ignore_zones = [];
-          // ignore signature box in the first 2 pages
-          ignore_zones.push(new PDFNet.Rect(1492, 56, 2236, 432));
-          opts.addIgnoreZonesForPage(ignore_zones, 1);
-
-          ignore_zones = [];
-          ignore_zones.push(new PDFNet.Rect(1492, 56, 2236, 432));
-          opts.addIgnoreZonesForPage(ignore_zones, 2);
-
-          // can use a combination of ignore and text boxes to focus on the page area of interest,
-          // as ignore boxes are applied first, we remove the arrows before selecting part of the diagram
-          ignore_zones = [];
-          ignore_zones.push(new PDFNet.Rect(992, 1276, 1368, 1372));
-          opts.addIgnoreZonesForPage(ignore_zones, 3);
-
-
-          const text_zones = [];
-          // we only have text zones selected in page 3
-
-          // select horizontal BUFFER ZONE sign
-          text_zones.push(new PDFNet.Rect(900, 2384, 1236, 2480));
-          // select right vertical BUFFER ZONE sign
-          text_zones.push(new PDFNet.Rect(1960, 1976, 2016, 2296));
-          // select Lot No.
-          text_zones.push(new PDFNet.Rect(696, 1028, 1196, 1128));
-
-          // select part of the plan inside the BUFFER ZONE
-          text_zones.push(new PDFNet.Rect(428, 1484, 1784, 2344));
-          text_zones.push(new PDFNet.Rect(948, 1288, 1672, 1476));
-          opts.addTextZonesForPage(text_zones, 3);
-
-          // C) Run OCR on the .tif with options
-          await PDFNet.OCRModule.imageToPDF(doc, input_path + 'bc_environment_protection.tif', opts);
-
-          // D) check the result
-          await doc.save(output_path + 'bc_environment_protection.pdf', 0);
-
-          console.log('Example 4: bc_environment_protection.tif');
-        } catch (err) {
-          console.log(err);
-        }
-
-        //--------------------------------------------------------------------------------
-        // Example 5) Alternative workflow for extracting OCR result JSON, postprocessing (e.g., removing words not in the dictionary or filtering special
-        // out special characters), and finally applying modified OCR JSON to the source PDF document 
-        try {
-          // A) Open the .pdf document
-          const doc = await PDFNet.PDFDoc.createFromFilePath(input_path + 'zero_value_test_no_text.pdf');
-          await doc.initSecurityHandler();
-
-          const opts = new PDFNet.OCRModule.OCROptions();
-          if(useIRIS) opts.setOCREngine('iris');
-
-          // B) Run OCR on the .pdf with default English language
-          const json = await PDFNet.OCRModule.getOCRJsonFromPDF(doc, opts);
-
-          // C) Post-processing step (whatever it might be)
-          console.log('Have OCR result JSON, re-applying to PDF ');
-
-          // D) Apply potentially modified OCR JSON to the PDF
-          await PDFNet.OCRModule.applyOCRJsonToPDF(doc, json);
-
-          // E) Check the result
-          await doc.save(output_path + 'zero_value_test_no_text.pdf', 0);
-
-          console.log('Example 5: extracting and applying OCR JSON from zero_value_test_no_text.pdf');
-        } catch (err) {
-          console.log(err);
-        }
-
-        //--------------------------------------------------------------------------------
-        // Example 6) The postprocessing workflow has also an option of extracting OCR results in XML format, similar to the one used by TextExtractor
-        try {
-
-          // A) Setup empty destination doc
-          const doc = await PDFNet.PDFDoc.create();
-          await doc.initSecurityHandler();
-
-          const opts = new PDFNet.OCRModule.OCROptions();
-          if(useIRIS) opts.setOCREngine('iris');
-
-          // B) Run OCR on the .tif with default English language, extracting OCR results in XML format. Note that
-          // in the process we convert the source image into PDF. We reuse this PDF document later to add hidden text layer to it.
-          const xml = await PDFNet.OCRModule.getOCRXmlFromImage(doc, input_path + 'physics.tif', opts);
-
-          // C) Post-processing step (whatever it might be)
-          console.log('Have OCR result XML, re-applying to PDF');
-
-          // D) Apply potentially modified OCR XML to the PDF
-          await PDFNet.OCRModule.applyOCRXmlToPDF(doc, xml);
-
-          // E) Check the result
-          await doc.save(output_path + 'physics.pdf', 0);
-
-          console.log('Example 6: extracting and applying OCR XML from physics.tif');
-        } catch (err) {
-          console.log(err);
-        }
-        console.log('Done.');
-      } 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.runOCRTest();
-})(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.
+//---------------------------------------------------------------------------------------
+
+
+const { PDFNet } = require('@pdftron/pdfnet-node');
+const PDFTronLicense = require('../LicenseKey/LicenseKey');
+
+((exports) => {
+  'use strict';
+
+  //---------------------------------------------------------------------------------------
+  // The following sample illustrates how to use OCR module
+  //---------------------------------------------------------------------------------------
+  exports.runOCRTest = () => {
+    const main = async () => {
+      try {
+
+        PDFNet.addResourceSearchPath('../../lib/');
+
+        const useIRIS = await PDFNet.OCRModule.isIRISModuleAvailable();
+        if (!(await PDFNet.OCRModule.isModuleAvailable())) {
+          console.log('\nUnable to run OCRTest: PDFTron SDK OCR module not available.');
+          console.log('---------------------------------------------------------------');
+          console.log('The OCR 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 input_path = '../TestFiles/OCR/';
+        const output_path = '../TestFiles/Output/';
+
+        //--------------------------------------------------------------------------------
+        // Example 1) Process image without specifying options, default language - English - is used
+        try {
+
+          // A) Setup empty destination doc
+          const doc = await PDFNet.PDFDoc.create();
+          
+          await doc.initSecurityHandler();
+
+          const opts = new PDFNet.OCRModule.OCROptions();
+          if(useIRIS) opts.setOCREngine('iris');
+
+          // B) Run OCR on the .png with options
+          await PDFNet.OCRModule.imageToPDF(doc, input_path + 'psychomachia_excerpt.png', opts);
+
+          // C) check the result
+          await doc.save(output_path + 'psychomachia_excerpt.pdf', 0);
+
+          console.log('Example 1: psychomachia_excerpt.png');
+
+        } catch (err) {
+          console.log(err);
+        }
+
+        //--------------------------------------------------------------------------------
+        // Example 2) Process document using multiple languages
+        try {
+          // A) Setup empty destination doc
+          const doc = await PDFNet.PDFDoc.create();
+          await doc.initSecurityHandler();
+
+          // B) Setup options with multiple target languages, English will always be considered as secondary language
+          const opts = new PDFNet.OCRModule.OCROptions();
+          if(useIRIS) opts.setOCREngine('iris');
+          opts.addLang('rus');
+          opts.addLang('deu');
+
+          // C) Run OCR on the .jpg with options
+          await PDFNet.OCRModule.imageToPDF(doc, input_path + 'multi_lang.jpg', opts);
+
+          // D) check the result
+          await doc.save(output_path + 'multi_lang.pdf', 0);
+
+          console.log('Example 2: multi_lang.jpg');
+        } catch (err) {
+          console.log(err);
+        }
+
+        //--------------------------------------------------------------------------------
+        // Example 3) Process a .pdf specifying a language - German - and ignore zone comprising a sidebar image 
+        try {
+          // A) Open the .pdf document
+          const doc = await PDFNet.PDFDoc.createFromFilePath(input_path + 'german_kids_song.pdf');
+          doc.initSecurityHandler();
+
+          // B) Setup options with a single language and an ignore zone
+          const opts = new PDFNet.OCRModule.OCROptions();
+          if(useIRIS) opts.setOCREngine('iris');
+          opts.addLang('deu');
+
+          const ignore_zones = [];
+          ignore_zones.push(new PDFNet.Rect(424, 163, 493, 730));
+          opts.addIgnoreZonesForPage(ignore_zones, 1);
+
+          // C) Run OCR on the .pdf with options
+          await PDFNet.OCRModule.processPDF(doc, opts);
+
+          // D) check the result
+          await doc.save(output_path + 'german_kids_song.pdf', 0);
+
+          console.log('Example 3: german_kids_song.pdf');
+        } catch (err) {
+          console.log(err);
+        }
+
+        //--------------------------------------------------------------------------------
+        // Example 4) Process multipage tiff with text/ignore zones specified for each page, optionally provide English as the target language
+        try {
+          // A) Setup empty destination doc
+          const doc = await PDFNet.PDFDoc.create();
+          await doc.initSecurityHandler();
+
+          // B) Setup options with a single language plus text/ignore zones
+          const opts = new PDFNet.OCRModule.OCROptions();
+          if(useIRIS) opts.setOCREngine('iris');
+          opts.addLang('eng');
+
+          var ignore_zones = [];
+          // ignore signature box in the first 2 pages
+          ignore_zones.push(new PDFNet.Rect(1492, 56, 2236, 432));
+          opts.addIgnoreZonesForPage(ignore_zones, 1);
+
+          ignore_zones = [];
+          ignore_zones.push(new PDFNet.Rect(1492, 56, 2236, 432));
+          opts.addIgnoreZonesForPage(ignore_zones, 2);
+
+          // can use a combination of ignore and text boxes to focus on the page area of interest,
+          // as ignore boxes are applied first, we remove the arrows before selecting part of the diagram
+          ignore_zones = [];
+          ignore_zones.push(new PDFNet.Rect(992, 1276, 1368, 1372));
+          opts.addIgnoreZonesForPage(ignore_zones, 3);
+
+
+          const text_zones = [];
+          // we only have text zones selected in page 3
+
+          // select horizontal BUFFER ZONE sign
+          text_zones.push(new PDFNet.Rect(900, 2384, 1236, 2480));
+          // select right vertical BUFFER ZONE sign
+          text_zones.push(new PDFNet.Rect(1960, 1976, 2016, 2296));
+          // select Lot No.
+          text_zones.push(new PDFNet.Rect(696, 1028, 1196, 1128));
+
+          // select part of the plan inside the BUFFER ZONE
+          text_zones.push(new PDFNet.Rect(428, 1484, 1784, 2344));
+          text_zones.push(new PDFNet.Rect(948, 1288, 1672, 1476));
+          opts.addTextZonesForPage(text_zones, 3);
+
+          // C) Run OCR on the .tif with options
+          await PDFNet.OCRModule.imageToPDF(doc, input_path + 'bc_environment_protection.tif', opts);
+
+          // D) check the result
+          await doc.save(output_path + 'bc_environment_protection.pdf', 0);
+
+          console.log('Example 4: bc_environment_protection.tif');
+        } catch (err) {
+          console.log(err);
+        }
+
+        //--------------------------------------------------------------------------------
+        // Example 5) Alternative workflow for extracting OCR result JSON, postprocessing (e.g., removing words not in the dictionary or filtering special
+        // out special characters), and finally applying modified OCR JSON to the source PDF document 
+        try {
+          // A) Open the .pdf document
+          const doc = await PDFNet.PDFDoc.createFromFilePath(input_path + 'zero_value_test_no_text.pdf');
+          await doc.initSecurityHandler();
+
+          const opts = new PDFNet.OCRModule.OCROptions();
+          if(useIRIS) opts.setOCREngine('iris');
+
+          // B) Run OCR on the .pdf with default English language
+          const json = await PDFNet.OCRModule.getOCRJsonFromPDF(doc, opts);
+
+          // C) Post-processing step (whatever it might be)
+          console.log('Have OCR result JSON, re-applying to PDF ');
+
+          // D) Apply potentially modified OCR JSON to the PDF
+          await PDFNet.OCRModule.applyOCRJsonToPDF(doc, json);
+
+          // E) Check the result
+          await doc.save(output_path + 'zero_value_test_no_text.pdf', 0);
+
+          console.log('Example 5: extracting and applying OCR JSON from zero_value_test_no_text.pdf');
+        } catch (err) {
+          console.log(err);
+        }
+
+        //--------------------------------------------------------------------------------
+        // Example 6) The postprocessing workflow has also an option of extracting OCR results in XML format, similar to the one used by TextExtractor
+        try {
+
+          // A) Setup empty destination doc
+          const doc = await PDFNet.PDFDoc.create();
+          await doc.initSecurityHandler();
+
+          const opts = new PDFNet.OCRModule.OCROptions();
+          if(useIRIS) opts.setOCREngine('iris');
+
+          // B) Run OCR on the .tif with default English language, extracting OCR results in XML format. Note that
+          // in the process we convert the source image into PDF. We reuse this PDF document later to add hidden text layer to it.
+          const xml = await PDFNet.OCRModule.getOCRXmlFromImage(doc, input_path + 'physics.tif', opts);
+
+          // C) Post-processing step (whatever it might be)
+          console.log('Have OCR result XML, re-applying to PDF');
+
+          // D) Apply potentially modified OCR XML to the PDF
+          await PDFNet.OCRModule.applyOCRXmlToPDF(doc, xml);
+
+          // E) Check the result
+          await doc.save(output_path + 'physics.pdf', 0);
+
+          console.log('Example 6: extracting and applying OCR XML from physics.tif');
+        } catch (err) {
+          console.log(err);
+        }
+        console.log('Done.');
+      } 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.runOCRTest();
+})(exports);
+// eslint-disable-next-line spaced-comment
 //# sourceURL=OCRTest.js

package/samples/OfficeTemplateTest/NODEJS/OfficeTemplateTest.js

@@ -0,0 +1,79 @@
+//---------------------------------------------------------------------------------------
+// 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 use the PDF::Convert utility class
+// to convert MS Office files to PDF and replace templated tags present in the document
+// with content supplied via json
+//
+// For a detailed specification of the template format and supported features,
+// see: https://www.pdftron.com/documentation/core/guides/generate-via-template/data-model/
+//
+// This conversion is performed entirely within the PDFNet and has *no*
+// external or system dependencies -- Conversion results will be
+// the same whether on Windows, Linux or Android.
+//
+// Please contact us if you have any questions.
+//------------------------------------------------------------------------------
+
+const { PDFNet } = require('../../../lib/pdfnet.js');
+const PDFTronLicense = require('../../LicenseKey/NODEJS/LicenseKey');
+
+((exports) => {
+  'use strict';
+
+  exports.runOfficeTemplateTest = () => {
+
+    const inputPath = '../../TestFiles/';
+    const outputPath = inputPath + 'Output/';
+    const inputFilename = 'SYH_Letter.docx'
+    const outputFilename = 'SYH_Letter.pdf'
+
+    const main = async () => {
+
+      PDFNet.addResourceSearchPath('../../Resources');
+
+      try {
+        const options = new PDFNet.Convert.OfficeToPDFOptions();
+
+        const json = JSON.stringify({
+          'dest_given_name': 'Janice N.',
+          'dest_street_address': "187 Duizelstraat",
+          'dest_surname': 'Symonds',
+          'dest_title': 'Ms.',
+          'land_location': '225 Parc St., Rochelle, QC ',
+          'lease_problem': 'According to the city records, the lease was initiated in September 2010 and never terminated',
+          'logo': { 'image_url': inputPath + 'logo_red.png', 'width' : 64, 'height':  64 },
+          'sender_name': 'Arnold Smith'
+        });
+
+        // Create a TemplateDocument object from an input office file.
+        const templateDoc = await PDFNet.Convert.createOfficeTemplateWithPath(inputPath + inputFilename, options);
+
+        // Fill the template with data from a JSON string, producing a PDF document.
+        const pdfdoc = await templateDoc.fillTemplateJson(json);
+
+        // Save the PDF to a file.
+        await pdfdoc.save(outputPath + outputFilename, PDFNet.SDFDoc.SaveOptions.e_linearized);
+
+        // And we're done!
+        console.log('Saved ' + 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.runOfficeTemplateTest();
+})(exports);
+// eslint-disable-next-line spaced-comment
+//# sourceURL=OfficeTemplateTest.js

package/samples/OfficeTemplateTest/NODEJS/RunTest.sh

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