@pdftron/pdfnet-node-samples 10.9.0 → 10.10.0

package/{samples/TextSearchTest → TextSearchTest}/TextSearchTest.js

@@ -1,122 +1,122 @@
-//---------------------------------------------------------------------------------------
-// Copyright (c) 2001-2024 by Apryse Software Inc. All Rights Reserved.
-// Consult legal.txt regarding legal and license information.
-//---------------------------------------------------------------------------------------
-
-
-const { PDFNet } = require('@pdftron/pdfnet-node');
-const PDFTronLicense = require('../LicenseKey/LicenseKey');
-
-((exports) => {
-
-  exports.runTextSearchTest = () => {
-
-    const main = async() => {
-      // Relative path to the folder containing test files.
-      const inputURL = '../TestFiles/';
-      const inputFilename = 'credit card numbers.pdf'; // addimage.pdf, newsletter.pdf
-
-      try {
-        const doc = await PDFNet.PDFDoc.createFromFilePath(inputURL + inputFilename);
-        doc.initSecurityHandler();
-
-        const txtSearch = await PDFNet.TextSearch.create();
-        let mode = PDFNet.TextSearch.Mode.e_whole_word + PDFNet.TextSearch.Mode.e_page_stop; // Uses both whole word and page stop
-        let pattern = 'joHn sMiTh';
-
-        txtSearch.begin(doc, pattern, mode); // searches for the "pattern" in the document while following the inputted modes.
-
-        let step = 0;
-
-        // call Run() iteratively to find all matching instances of the word 'joHn sMiTh'
-        /* eslint-disable-next-line no-constant-condition */
-        while (true) {
-          const result = await txtSearch.run();
-          let hlts;
-          if (result.code === PDFNet.TextSearch.ResultCode.e_found) {
-            if (step === 0) { // Step 0: found "John Smith"
-              // note that, here, 'ambient_str' and 'highlights' are not written to,
-              // as 'e_ambient_string' and 'e_highlight' are not set.
-              console.log(result.out_str + "'s credit card number is: ");
-
-              // now switch to using regular expressions to find John's credit card number
-              mode = await txtSearch.getMode();
-              mode += PDFNet.TextSearch.Mode.e_reg_expression + PDFNet.TextSearch.Mode.e_highlight;
-              txtSearch.setMode(mode);
-              pattern = '\\d{4}-\\d{4}-\\d{4}-\\d{4}'; // or "(\\d{4}-){3}\\d{4}"
-              txtSearch.setPattern(pattern);
-
-              ++step;
-            } else if (step === 1) {
-              // step 1: found John's credit card number
-              console.log('  ' + result.out_str);
-              // note that, here, 'hlts' is written to, as 'e_highlight' has been set.
-              // output the highlight info of the credit card number.
-              hlts = result.highlights;
-              hlts.begin(doc);
-              while ((await hlts.hasNext())) {
-                const highlightPageNum = await hlts.getCurrentPageNumber();
-                console.log('The current highlight is from page: ' + highlightPageNum);
-                await hlts.next();
-              }
-              // see if there is an AMEX card number
-              pattern = '\\d{4}-\\d{6}-\\d{5}';
-              txtSearch.setPattern(pattern);
-
-              ++step;
-            } else if (step === 2) {
-              // found an AMEX card number
-              console.log('\nThere is an AMEX card number:\n  ' + result.out_str);
-
-              // change mode to find the owner of the credit card; supposedly, the owner's
-              // name proceeds the number
-              mode = await txtSearch.getMode();
-              mode += PDFNet.TextSearch.Mode.e_search_up;
-              txtSearch.setMode(mode);
-              pattern = '[A-z]++ [A-z]++';
-              txtSearch.setPattern(pattern);
-
-              ++step;
-            } else if (step === 3) {
-              // found the owner's name of the AMEX card
-              console.log("Is the owner's name:\n  " + result.out_str + '?');
-
-              // add a link annotation based on the location of the found instance
-              hlts = result.highlights;
-              await hlts.begin(doc); // is await needed?
-              while ((await hlts.hasNext())) {
-                const curPage = await doc.getPage((await hlts.getCurrentPageNumber()));
-                const quadArr = await hlts.getCurrentQuads();
-                for (let i = 0; i < quadArr.length; ++i) {
-                  const currQuad = quadArr[i];
-                  const x1 = Math.min(Math.min(Math.min(currQuad.p1x, currQuad.p2x), currQuad.p3x), currQuad.p4x);
-                  const x2 = Math.max(Math.max(Math.max(currQuad.p1x, currQuad.p2x), currQuad.p3x), currQuad.p4x);
-                  const y1 = Math.min(Math.min(Math.min(currQuad.p1y, currQuad.p2y), currQuad.p3y), currQuad.p4y);
-                  const y2 = Math.max(Math.max(Math.max(currQuad.p1y, currQuad.p2y), currQuad.p3y), currQuad.p4y);
-
-                  const hyperLink = await PDFNet.LinkAnnot.create(doc, (await PDFNet.Rect.init(x1, y1, x2, y2)));
-                  await hyperLink.setAction((await PDFNet.Action.createURI(doc, 'http://www.pdftron.com')));
-                  await curPage.annotPushBack(hyperLink);
-                }
-                hlts.next();
-              }
-              await doc.save('../TestFiles/Output/credit card numbers_linked.pdf', PDFNet.SDFDoc.SaveOptions.e_linearized);
-              break;
-            }
-          } else if (result.code === PDFNet.TextSearch.ResultCode.e_page) {
-            // you can update your UI here, if needed
-            console.log('page end');
-          } else if (result.code === PDFNet.TextSearch.ResultCode.e_done) {
-            break;
-          }
-        }
-      } 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.runTextSearchTest();
-})(exports);
-// eslint-disable-next-line spaced-comment
+//---------------------------------------------------------------------------------------
+// Copyright (c) 2001-2024 by Apryse Software Inc. All Rights Reserved.
+// Consult legal.txt regarding legal and license information.
+//---------------------------------------------------------------------------------------
+
+
+const { PDFNet } = require('@pdftron/pdfnet-node');
+const PDFTronLicense = require('../LicenseKey/LicenseKey');
+
+((exports) => {
+
+  exports.runTextSearchTest = () => {
+
+    const main = async() => {
+      // Relative path to the folder containing test files.
+      const inputURL = '../TestFiles/';
+      const inputFilename = 'credit card numbers.pdf'; // addimage.pdf, newsletter.pdf
+
+      try {
+        const doc = await PDFNet.PDFDoc.createFromFilePath(inputURL + inputFilename);
+        doc.initSecurityHandler();
+
+        const txtSearch = await PDFNet.TextSearch.create();
+        let mode = PDFNet.TextSearch.Mode.e_whole_word + PDFNet.TextSearch.Mode.e_page_stop; // Uses both whole word and page stop
+        let pattern = 'joHn sMiTh';
+
+        txtSearch.begin(doc, pattern, mode); // searches for the "pattern" in the document while following the inputted modes.
+
+        let step = 0;
+
+        // call Run() iteratively to find all matching instances of the word 'joHn sMiTh'
+        /* eslint-disable-next-line no-constant-condition */
+        while (true) {
+          const result = await txtSearch.run();
+          let hlts;
+          if (result.code === PDFNet.TextSearch.ResultCode.e_found) {
+            if (step === 0) { // Step 0: found "John Smith"
+              // note that, here, 'ambient_str' and 'highlights' are not written to,
+              // as 'e_ambient_string' and 'e_highlight' are not set.
+              console.log(result.out_str + "'s credit card number is: ");
+
+              // now switch to using regular expressions to find John's credit card number
+              mode = await txtSearch.getMode();
+              mode += PDFNet.TextSearch.Mode.e_reg_expression + PDFNet.TextSearch.Mode.e_highlight;
+              txtSearch.setMode(mode);
+              pattern = '\\d{4}-\\d{4}-\\d{4}-\\d{4}'; // or "(\\d{4}-){3}\\d{4}"
+              txtSearch.setPattern(pattern);
+
+              ++step;
+            } else if (step === 1) {
+              // step 1: found John's credit card number
+              console.log('  ' + result.out_str);
+              // note that, here, 'hlts' is written to, as 'e_highlight' has been set.
+              // output the highlight info of the credit card number.
+              hlts = result.highlights;
+              hlts.begin(doc);
+              while ((await hlts.hasNext())) {
+                const highlightPageNum = await hlts.getCurrentPageNumber();
+                console.log('The current highlight is from page: ' + highlightPageNum);
+                await hlts.next();
+              }
+              // see if there is an AMEX card number
+              pattern = '\\d{4}-\\d{6}-\\d{5}';
+              txtSearch.setPattern(pattern);
+
+              ++step;
+            } else if (step === 2) {
+              // found an AMEX card number
+              console.log('\nThere is an AMEX card number:\n  ' + result.out_str);
+
+              // change mode to find the owner of the credit card; supposedly, the owner's
+              // name proceeds the number
+              mode = await txtSearch.getMode();
+              mode += PDFNet.TextSearch.Mode.e_search_up;
+              txtSearch.setMode(mode);
+              pattern = '[A-z]++ [A-z]++';
+              txtSearch.setPattern(pattern);
+
+              ++step;
+            } else if (step === 3) {
+              // found the owner's name of the AMEX card
+              console.log("Is the owner's name:\n  " + result.out_str + '?');
+
+              // add a link annotation based on the location of the found instance
+              hlts = result.highlights;
+              await hlts.begin(doc); // is await needed?
+              while ((await hlts.hasNext())) {
+                const curPage = await doc.getPage((await hlts.getCurrentPageNumber()));
+                const quadArr = await hlts.getCurrentQuads();
+                for (let i = 0; i < quadArr.length; ++i) {
+                  const currQuad = quadArr[i];
+                  const x1 = Math.min(Math.min(Math.min(currQuad.p1x, currQuad.p2x), currQuad.p3x), currQuad.p4x);
+                  const x2 = Math.max(Math.max(Math.max(currQuad.p1x, currQuad.p2x), currQuad.p3x), currQuad.p4x);
+                  const y1 = Math.min(Math.min(Math.min(currQuad.p1y, currQuad.p2y), currQuad.p3y), currQuad.p4y);
+                  const y2 = Math.max(Math.max(Math.max(currQuad.p1y, currQuad.p2y), currQuad.p3y), currQuad.p4y);
+
+                  const hyperLink = await PDFNet.LinkAnnot.create(doc, (await PDFNet.Rect.init(x1, y1, x2, y2)));
+                  await hyperLink.setAction((await PDFNet.Action.createURI(doc, 'http://www.pdftron.com')));
+                  await curPage.annotPushBack(hyperLink);
+                }
+                hlts.next();
+              }
+              await doc.save('../TestFiles/Output/credit card numbers_linked.pdf', PDFNet.SDFDoc.SaveOptions.e_linearized);
+              break;
+            }
+          } else if (result.code === PDFNet.TextSearch.ResultCode.e_page) {
+            // you can update your UI here, if needed
+            console.log('page end');
+          } else if (result.code === PDFNet.TextSearch.ResultCode.e_done) {
+            break;
+          }
+        }
+      } 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.runTextSearchTest();
+})(exports);
+// eslint-disable-next-line spaced-comment
 //# sourceURL=TextSearchTest.js

package/{samples/U3DTest → U3DTest}/U3DTest.js

@@ -1,105 +1,105 @@
-//---------------------------------------------------------------------------------------
-// Copyright (c) 2001-2024 by Apryse Software 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';
-
-  exports.runU3DTest = () => {
-    const input_path = '../TestFiles/';
-
-    const create3DAnnotation = async (doc, annots) => {
-      // ---------------------------------------------------------------------------------
-      // Create a 3D annotation based on U3D content. PDF 1.6 introduces the capability 
-      // for collections of three-dimensional objects, such as those used by CAD software, 
-      // to be embedded in PDF files.
-      const link_3D = await doc.createIndirectDict();
-      link_3D.putName('Subtype', '3D');
-
-      // Annotation location on the page
-      const link_3D_rect = await PDFNet.Rect.init(25, 180, 585, 643);
-      link_3D.putRect('Rect', link_3D_rect.x1, link_3D_rect.y1,
-        link_3D_rect.x2, link_3D_rect.y2);
-      annots.pushBack(link_3D);
-
-      // The 3DA entry is an activation dictionary (see Table 9.34 in the PDF Reference Manual) 
-      // that determines how the state of the annotation and its associated artwork can change.
-      const activation_dict_3D = await link_3D.putDict('3DA');
-
-      // Set the annotation so that it is activated as soon as the page containing the 
-      // annotation is opened. Other options are: PV (page view) and XA (explicit) activation.
-      activation_dict_3D.putName('A', 'PO');
-
-      // Embed U3D Streams (3D Model/Artwork).
-      const u3d_file = await PDFNet.Filter.createMappedFileFromUString(input_path + 'dice.u3d');
-      const u3d_reader = await PDFNet.FilterReader.create(u3d_file);
-
-      // To embed 3D stream without compression, you can omit the second parameter in CreateIndirectStream.
-      const flateEncode = await PDFNet.Filter.createFlateEncode();
-      const u3d_data_dict = await doc.createIndirectStreamFromFilter(u3d_reader, flateEncode);
-      u3d_data_dict.putName('Subtype', 'U3D');
-      link_3D.put('3DD', u3d_data_dict);
-
-      // Set the initial view of the 3D artwork that should be used when the annotation is activated.
-      const view3D_dict = await link_3D.putDict('3DV');
-      view3D_dict.putString('IN', 'Unnamed');
-      view3D_dict.putString('XN', 'Default');
-      view3D_dict.putName('MS', 'M');
-      view3D_dict.putNumber('CO', 27.5);
-
-      // A 12-element 3D transformation matrix that specifies a position and orientation 
-      // of the camera in world coordinates.
-      const tr3d = await view3D_dict.putArray('C2W');
-      tr3d.pushBackNumber(1); tr3d.pushBackNumber(0); tr3d.pushBackNumber(0);
-      tr3d.pushBackNumber(0); tr3d.pushBackNumber(0); tr3d.pushBackNumber(-1);
-      tr3d.pushBackNumber(0); tr3d.pushBackNumber(1); tr3d.pushBackNumber(0);
-      tr3d.pushBackNumber(0); tr3d.pushBackNumber(-27.5); tr3d.pushBackNumber(0);
-
-      // Create annotation appearance stream, a thumbnail which is used during printing or
-      // in PDF processors that do not understand 3D data.
-      const ap_dict = await link_3D.putDict('AP');
-
-      const builder = await PDFNet.ElementBuilder.create();
-      const writer = await PDFNet.ElementWriter.create();
-
-      writer.begin(doc);
-
-      const thumb_pathname = input_path + 'dice.jpg';
-      const image = await PDFNet.Image.createFromFile(doc, thumb_pathname);
-      writer.writePlacedElement(await builder.createImageScaled(image, 0.0, 0.0, await link_3D_rect.width(), await link_3D_rect.height()));
-
-      const normal_ap_stream = await writer.end();
-      normal_ap_stream.putName('Subtype', 'Form');
-      normal_ap_stream.putRect('BBox', 0, 0, await link_3D_rect.width(), await link_3D_rect.height());
-      ap_dict.put('N', normal_ap_stream);
-    }
-
-    const main = async () => {
-      const output_path = '../TestFiles/Output/';
-
-      try {
-        const doc = await PDFNet.PDFDoc.create();
-        const page = await doc.pageCreate();
-        doc.pagePushBack(page);
-        const annots = await doc.createIndirectArray();
-        page.getSDFObj().then(sdf => sdf.put('Annots', annots));
-
-        await create3DAnnotation(doc, annots);
-        doc.save(output_path + 'dice_u3d.pdf', PDFNet.SDFDoc.SaveOptions.e_linearized);
-        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.runU3DTest();
-})(exports);
-// eslint-disable-next-line spaced-comment
+//---------------------------------------------------------------------------------------
+// Copyright (c) 2001-2024 by Apryse Software 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';
+
+  exports.runU3DTest = () => {
+    const input_path = '../TestFiles/';
+
+    const create3DAnnotation = async (doc, annots) => {
+      // ---------------------------------------------------------------------------------
+      // Create a 3D annotation based on U3D content. PDF 1.6 introduces the capability 
+      // for collections of three-dimensional objects, such as those used by CAD software, 
+      // to be embedded in PDF files.
+      const link_3D = await doc.createIndirectDict();
+      link_3D.putName('Subtype', '3D');
+
+      // Annotation location on the page
+      const link_3D_rect = await PDFNet.Rect.init(25, 180, 585, 643);
+      link_3D.putRect('Rect', link_3D_rect.x1, link_3D_rect.y1,
+        link_3D_rect.x2, link_3D_rect.y2);
+      annots.pushBack(link_3D);
+
+      // The 3DA entry is an activation dictionary (see Table 9.34 in the PDF Reference Manual) 
+      // that determines how the state of the annotation and its associated artwork can change.
+      const activation_dict_3D = await link_3D.putDict('3DA');
+
+      // Set the annotation so that it is activated as soon as the page containing the 
+      // annotation is opened. Other options are: PV (page view) and XA (explicit) activation.
+      activation_dict_3D.putName('A', 'PO');
+
+      // Embed U3D Streams (3D Model/Artwork).
+      const u3d_file = await PDFNet.Filter.createMappedFileFromUString(input_path + 'dice.u3d');
+      const u3d_reader = await PDFNet.FilterReader.create(u3d_file);
+
+      // To embed 3D stream without compression, you can omit the second parameter in CreateIndirectStream.
+      const flateEncode = await PDFNet.Filter.createFlateEncode();
+      const u3d_data_dict = await doc.createIndirectStreamFromFilter(u3d_reader, flateEncode);
+      u3d_data_dict.putName('Subtype', 'U3D');
+      link_3D.put('3DD', u3d_data_dict);
+
+      // Set the initial view of the 3D artwork that should be used when the annotation is activated.
+      const view3D_dict = await link_3D.putDict('3DV');
+      view3D_dict.putString('IN', 'Unnamed');
+      view3D_dict.putString('XN', 'Default');
+      view3D_dict.putName('MS', 'M');
+      view3D_dict.putNumber('CO', 27.5);
+
+      // A 12-element 3D transformation matrix that specifies a position and orientation 
+      // of the camera in world coordinates.
+      const tr3d = await view3D_dict.putArray('C2W');
+      tr3d.pushBackNumber(1); tr3d.pushBackNumber(0); tr3d.pushBackNumber(0);
+      tr3d.pushBackNumber(0); tr3d.pushBackNumber(0); tr3d.pushBackNumber(-1);
+      tr3d.pushBackNumber(0); tr3d.pushBackNumber(1); tr3d.pushBackNumber(0);
+      tr3d.pushBackNumber(0); tr3d.pushBackNumber(-27.5); tr3d.pushBackNumber(0);
+
+      // Create annotation appearance stream, a thumbnail which is used during printing or
+      // in PDF processors that do not understand 3D data.
+      const ap_dict = await link_3D.putDict('AP');
+
+      const builder = await PDFNet.ElementBuilder.create();
+      const writer = await PDFNet.ElementWriter.create();
+
+      writer.begin(doc);
+
+      const thumb_pathname = input_path + 'dice.jpg';
+      const image = await PDFNet.Image.createFromFile(doc, thumb_pathname);
+      writer.writePlacedElement(await builder.createImageScaled(image, 0.0, 0.0, await link_3D_rect.width(), await link_3D_rect.height()));
+
+      const normal_ap_stream = await writer.end();
+      normal_ap_stream.putName('Subtype', 'Form');
+      normal_ap_stream.putRect('BBox', 0, 0, await link_3D_rect.width(), await link_3D_rect.height());
+      ap_dict.put('N', normal_ap_stream);
+    }
+
+    const main = async () => {
+      const output_path = '../TestFiles/Output/';
+
+      try {
+        const doc = await PDFNet.PDFDoc.create();
+        const page = await doc.pageCreate();
+        doc.pagePushBack(page);
+        const annots = await doc.createIndirectArray();
+        page.getSDFObj().then(sdf => sdf.put('Annots', annots));
+
+        await create3DAnnotation(doc, annots);
+        doc.save(output_path + 'dice_u3d.pdf', PDFNet.SDFDoc.SaveOptions.e_linearized);
+        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.runU3DTest();
+})(exports);
+// eslint-disable-next-line spaced-comment
 //# sourceURL=U3DTest.js