@pdftron/pdfnet-node-samples 10.7.0 → 10.8.0

package/samples/PDFRedactTest/PDFRedactTest.js

@@ -1,75 +1,75 @@
-//---------------------------------------------------------------------------------------
-// Copyright (c) 2001-2024 by Apryse Software Inc. All Rights Reserved.
-// Consult legal.txt regarding legal and license information.
-//---------------------------------------------------------------------------------------
-
-// PDF Redactor is a separately licensable Add-on that offers options to remove 
-// (not just covering or obscuring) content within a region of PDF. 
-// With printed pages, redaction involves blacking-out or cutting-out areas of 
-// the printed page. With electronic documents that use formats such as PDF, 
-// redaction typically involves removing sensitive content within documents for 
-// safe distribution to courts, patent and government institutions, the media, 
-// customers, vendors or any other audience with restricted access to the content. 
-//
-// The redaction process in PDFNet consists of two steps:
-// 
-//  a) Content identification: A user applies redact annotations that specify the 
-// pieces or regions of content that should be removed. The content for redaction 
-// can be identified either interactively (e.g. using 'pdftron.PDF.PDFViewCtrl' 
-// as shown in PDFView sample) or programmatically (e.g. using 'pdftron.PDF.TextSearch'
-// or 'pdftron.PDF.TextExtractor'). Up until the next step is performed, the user 
-// can see, move and redefine these annotations.
-//  b) Content removal: Using 'pdftron.PDF.Redactor.Redact()' the user instructs 
-// PDFNet to apply the redact regions, after which the content in the area specified 
-// by the redact annotations is removed. The redaction function includes number of 
-// options to control the style of the redaction overlay (including color, text, 
-// font, border, transparency, etc.).
-// 
-// PDFTron Redactor makes sure that if a portion of an image, text, or vector graphics 
-// is contained in a redaction region, that portion of the image or path data is 
-// destroyed and is not simply hidden with clipping or image masks. PDFNet API can also 
-// be used to review and remove metadata and other content that can exist in a PDF 
-// document, including XML Forms Architecture (XFA) content and Extensible Metadata 
-// Platform (XMP) content.
-
-const { PDFNet } = require('@pdftron/pdfnet-node');
-const PDFTronLicense = require('../LicenseKey/LicenseKey');
-
-((exports) => {
-
-  exports.runPDFRedactTest = () => {
-    const redact = async(input, output, vec, app) => {
-      const doc = await PDFNet.PDFDoc.createFromFilePath(input);
-      if (await doc.initSecurityHandler()) {
-        PDFNet.Redactor.redact(doc, vec, app, false, true);
-        await doc.save(output, PDFNet.SDFDoc.SaveOptions.e_linearized);
-      }
-    };
-
-    const main = async() => {
-      // Relative path to the folder containing test files.
-      const inputPath = '../TestFiles/';
-      try {
-        const redactionArray = []; // we will contain a list of redaction objects in this array
-        redactionArray.push(await PDFNet.Redactor.redactionCreate(1, (await PDFNet.Rect.init(100, 100, 550, 600)), false, 'Top Secret'));
-        redactionArray.push(await PDFNet.Redactor.redactionCreate(2, (await PDFNet.Rect.init(30, 30, 450, 450)), true, 'Negative Redaction'));
-        redactionArray.push(await PDFNet.Redactor.redactionCreate(2, (await PDFNet.Rect.init(0, 0, 100, 100)), false, 'Positive'));
-        redactionArray.push(await PDFNet.Redactor.redactionCreate(2, (await PDFNet.Rect.init(100, 100, 200, 200)), false, 'Positive'));
-        redactionArray.push(await PDFNet.Redactor.redactionCreate(2, (await PDFNet.Rect.init(300, 300, 400, 400)), false, ''));
-        redactionArray.push(await PDFNet.Redactor.redactionCreate(2, (await PDFNet.Rect.init(500, 500, 600, 600)), false, ''));
-        redactionArray.push(await PDFNet.Redactor.redactionCreate(3, (await PDFNet.Rect.init(0, 0, 700, 20)), false, ''));
-
-        const appear = { redaction_overlay: true, border: false, show_redacted_content_regions: true };
-        await redact(inputPath + 'newsletter.pdf', inputPath + 'Output/redacted.pdf', redactionArray, appear);
-
-        console.log('Done...');
-      } catch (err) {
-        console.log(err.stack);
-      }
-    };
-    PDFNet.runWithCleanup(main, PDFTronLicense.Key).catch(function(error){console.log('Error: ' + JSON.stringify(error));}).then(function(){return PDFNet.shutdown();});
-  };
-  exports.runPDFRedactTest();
-})(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.
+//---------------------------------------------------------------------------------------
+
+// PDF Redactor is a separately licensable Add-on that offers options to remove 
+// (not just covering or obscuring) content within a region of PDF. 
+// With printed pages, redaction involves blacking-out or cutting-out areas of 
+// the printed page. With electronic documents that use formats such as PDF, 
+// redaction typically involves removing sensitive content within documents for 
+// safe distribution to courts, patent and government institutions, the media, 
+// customers, vendors or any other audience with restricted access to the content. 
+//
+// The redaction process in PDFNet consists of two steps:
+// 
+//  a) Content identification: A user applies redact annotations that specify the 
+// pieces or regions of content that should be removed. The content for redaction 
+// can be identified either interactively (e.g. using 'pdftron.PDF.PDFViewCtrl' 
+// as shown in PDFView sample) or programmatically (e.g. using 'pdftron.PDF.TextSearch'
+// or 'pdftron.PDF.TextExtractor'). Up until the next step is performed, the user 
+// can see, move and redefine these annotations.
+//  b) Content removal: Using 'pdftron.PDF.Redactor.Redact()' the user instructs 
+// PDFNet to apply the redact regions, after which the content in the area specified 
+// by the redact annotations is removed. The redaction function includes number of 
+// options to control the style of the redaction overlay (including color, text, 
+// font, border, transparency, etc.).
+// 
+// PDFTron Redactor makes sure that if a portion of an image, text, or vector graphics 
+// is contained in a redaction region, that portion of the image or path data is 
+// destroyed and is not simply hidden with clipping or image masks. PDFNet API can also 
+// be used to review and remove metadata and other content that can exist in a PDF 
+// document, including XML Forms Architecture (XFA) content and Extensible Metadata 
+// Platform (XMP) content.
+
+const { PDFNet } = require('@pdftron/pdfnet-node');
+const PDFTronLicense = require('../LicenseKey/LicenseKey');
+
+((exports) => {
+
+  exports.runPDFRedactTest = () => {
+    const redact = async(input, output, vec, app) => {
+      const doc = await PDFNet.PDFDoc.createFromFilePath(input);
+      if (await doc.initSecurityHandler()) {
+        PDFNet.Redactor.redact(doc, vec, app, false, true);
+        await doc.save(output, PDFNet.SDFDoc.SaveOptions.e_linearized);
+      }
+    };
+
+    const main = async() => {
+      // Relative path to the folder containing test files.
+      const inputPath = '../TestFiles/';
+      try {
+        const redactionArray = []; // we will contain a list of redaction objects in this array
+        redactionArray.push(await PDFNet.Redactor.redactionCreate(1, (await PDFNet.Rect.init(100, 100, 550, 600)), false, 'Top Secret'));
+        redactionArray.push(await PDFNet.Redactor.redactionCreate(2, (await PDFNet.Rect.init(30, 30, 450, 450)), true, 'Negative Redaction'));
+        redactionArray.push(await PDFNet.Redactor.redactionCreate(2, (await PDFNet.Rect.init(0, 0, 100, 100)), false, 'Positive'));
+        redactionArray.push(await PDFNet.Redactor.redactionCreate(2, (await PDFNet.Rect.init(100, 100, 200, 200)), false, 'Positive'));
+        redactionArray.push(await PDFNet.Redactor.redactionCreate(2, (await PDFNet.Rect.init(300, 300, 400, 400)), false, ''));
+        redactionArray.push(await PDFNet.Redactor.redactionCreate(2, (await PDFNet.Rect.init(500, 500, 600, 600)), false, ''));
+        redactionArray.push(await PDFNet.Redactor.redactionCreate(3, (await PDFNet.Rect.init(0, 0, 700, 20)), false, ''));
+
+        const appear = { redaction_overlay: true, border: false, show_redacted_content_regions: true };
+        await redact(inputPath + 'newsletter.pdf', inputPath + 'Output/redacted.pdf', redactionArray, appear);
+
+        console.log('Done...');
+      } catch (err) {
+        console.log(err.stack);
+      }
+    };
+    PDFNet.runWithCleanup(main, PDFTronLicense.Key).catch(function(error){console.log('Error: ' + JSON.stringify(error));}).then(function(){return PDFNet.shutdown();});
+  };
+  exports.runPDFRedactTest();
+})(exports);
+// eslint-disable-next-line spaced-comment
 //# sourceURL=PDFRedactTest.js

package/samples/PageLabelsTest/PageLabelsTest.js

@@ -1,139 +1,139 @@
-//---------------------------------------------------------------------------------------
-// Copyright (c) 2001-2024 by Apryse Software Inc. All Rights Reserved.
-// Consult legal.txt regarding legal and license information.
-//---------------------------------------------------------------------------------------
-
-//-----------------------------------------------------------------------------------
-// The sample illustrates how to work with PDF page labels.
-//
-// PDF page labels can be used to describe a page. This is used to 
-// allow for non-sequential page numbering or the addition of arbitrary 
-// labels for a page (such as the inclusion of Roman numerals at the 
-// beginning of a book). PDFNet PageLabel object can be used to specify 
-// the numbering style to use (for example, upper- or lower-case Roman, 
-// decimal, and so forth), the starting number for the first page,
-// and an arbitrary prefix to be pre-appended to each number (for 
-// example, 'A-' to generate 'A-1', 'A-2', 'A-3', and so forth.)
-//-----------------------------------------------------------------------------------
-
-const { PDFNet } = require('@pdftron/pdfnet-node');
-const PDFTronLicense = require('../LicenseKey/LicenseKey');
-
-((exports) => {
-  'use strict';
-
-  exports.runPageLabelsTest = () => {
-    const main = async () => {
-      const inputPath = '../TestFiles/';
-      const outputPath = inputPath + 'Output/';
-      const outputFile = outputPath + 'newsletter_with_pagelabels.pdf';
-
-      try {
-        //-----------------------------------------------------------
-        // Example 1: Add page labels to an existing or newly created PDF
-        // document.
-        //-----------------------------------------------------------
-        {
-          const doc = await PDFNet.PDFDoc.createFromFilePath(inputPath + 'newsletter.pdf');
-          doc.initSecurityHandler();
-
-          // Create a page labeling scheme that starts with the first page in 
-          // the document (page 1) and is using uppercase roman numbering 
-          // style. 
-          const L1 = await PDFNet.PageLabel.create(doc, PDFNet.PageLabel.Style.e_roman_uppercase, 'My Prefix ', 1);
-          doc.setPageLabel(1, L1);
-
-          // Create a page labeling scheme that starts with the fourth page in 
-          // the document and is using decimal Arabic numbering style. 
-          // Also the numeric portion of the first label should start with number 
-          // 4 (otherwise the first label would be 'My Prefix 1'). 
-          const L2 = await PDFNet.PageLabel.create(doc, PDFNet.PageLabel.Style.e_decimal, 'My Prefix ', 4);
-          doc.setPageLabel(4, L2);
-
-          // Create a page labeling scheme that starts with the seventh page in 
-          // the document and is using alphabetic numbering style. The numeric 
-          // portion of the first label should start with number 1. 
-          const L3 = await PDFNet.PageLabel.create(doc, PDFNet.PageLabel.Style.e_alphabetic_uppercase, 'My Prefix ', 1);
-          doc.setPageLabel(7, L3);
-
-          doc.save(outputFile, PDFNet.SDFDoc.SaveOptions.e_linearized);
-          console.log('Done. Result saved in newsletter_with_pagelabels.pdf...');
-        }
-
-        //-----------------------------------------------------------
-        // Example 2: Read page labels from an existing PDF document.
-        //-----------------------------------------------------------
-        {
-          const doc = await PDFNet.PDFDoc.createFromFilePath(outputFile);
-          doc.initSecurityHandler();
-
-          const page_num = await doc.getPageCount();
-          for (let i = 1; i <= page_num; ++i) {
-            console.log('Page number: ' + i);
-            const label = await doc.getPageLabel(i);
-            if (await label.isValid()) {
-              console.log(' Label: ' + await label.getLabelTitle(i));
-            }
-            else {
-              console.log(' No Label.');
-            }
-          }
-        }
-
-        //-----------------------------------------------------------
-        // Example 3: Modify page labels from an existing PDF document.
-        //-----------------------------------------------------------
-        {
-          const doc = await PDFNet.PDFDoc.createFromFilePath(outputFile);
-          doc.initSecurityHandler();
-
-          // Remove the alphabetic labels from example 1.
-          doc.removePageLabel(7);
-
-          // Replace the Prefix in the decimal labels (from example 1).
-          const label = await doc.getPageLabel(4);
-          if (await label.isValid()) {
-            await label.setPrefix('A');
-            label.setStart(1);
-          }
-
-          // Add a new label
-          const new_label = await PDFNet.PageLabel.create(doc, PDFNet.PageLabel.Style.e_decimal, 'B', 1);
-          doc.setPageLabel(10, new_label);  // starting from page 10.
-
-          doc.save(outputPath + 'newsletter_with_pagelabels_modified.pdf', PDFNet.SDFDoc.SaveOptions.e_linearized);
-          console.log('Done. Result saved in newsletter_with_pagelabels_modified.pdf...');
-
-          const page_num = await doc.getPageCount();
-          for (let i = 1; i <= page_num; ++i) {
-            console.log('Page number: ' + i);
-            const label = await doc.getPageLabel(i);
-            if (await label.isValid()) {
-              console.log(' Label: ' + await label.getLabelTitle(i));
-            }
-            else {
-              console.log(' No Label.');
-            }
-          }
-        }
-
-        //-----------------------------------------------------------
-        // Example 4: Delete all page labels in an existing PDF document.
-        //-----------------------------------------------------------
-        {
-          const doc = await PDFNet.PDFDoc.createFromFilePath(outputFile);
-          (await doc.getRoot()).eraseFromKey('PageLabels');
-        }
-
-      } 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.runPageLabelsTest();
-})(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.
+//---------------------------------------------------------------------------------------
+
+//-----------------------------------------------------------------------------------
+// The sample illustrates how to work with PDF page labels.
+//
+// PDF page labels can be used to describe a page. This is used to 
+// allow for non-sequential page numbering or the addition of arbitrary 
+// labels for a page (such as the inclusion of Roman numerals at the 
+// beginning of a book). PDFNet PageLabel object can be used to specify 
+// the numbering style to use (for example, upper- or lower-case Roman, 
+// decimal, and so forth), the starting number for the first page,
+// and an arbitrary prefix to be pre-appended to each number (for 
+// example, 'A-' to generate 'A-1', 'A-2', 'A-3', and so forth.)
+//-----------------------------------------------------------------------------------
+
+const { PDFNet } = require('@pdftron/pdfnet-node');
+const PDFTronLicense = require('../LicenseKey/LicenseKey');
+
+((exports) => {
+  'use strict';
+
+  exports.runPageLabelsTest = () => {
+    const main = async () => {
+      const inputPath = '../TestFiles/';
+      const outputPath = inputPath + 'Output/';
+      const outputFile = outputPath + 'newsletter_with_pagelabels.pdf';
+
+      try {
+        //-----------------------------------------------------------
+        // Example 1: Add page labels to an existing or newly created PDF
+        // document.
+        //-----------------------------------------------------------
+        {
+          const doc = await PDFNet.PDFDoc.createFromFilePath(inputPath + 'newsletter.pdf');
+          doc.initSecurityHandler();
+
+          // Create a page labeling scheme that starts with the first page in 
+          // the document (page 1) and is using uppercase roman numbering 
+          // style. 
+          const L1 = await PDFNet.PageLabel.create(doc, PDFNet.PageLabel.Style.e_roman_uppercase, 'My Prefix ', 1);
+          doc.setPageLabel(1, L1);
+
+          // Create a page labeling scheme that starts with the fourth page in 
+          // the document and is using decimal Arabic numbering style. 
+          // Also the numeric portion of the first label should start with number 
+          // 4 (otherwise the first label would be 'My Prefix 1'). 
+          const L2 = await PDFNet.PageLabel.create(doc, PDFNet.PageLabel.Style.e_decimal, 'My Prefix ', 4);
+          doc.setPageLabel(4, L2);
+
+          // Create a page labeling scheme that starts with the seventh page in 
+          // the document and is using alphabetic numbering style. The numeric 
+          // portion of the first label should start with number 1. 
+          const L3 = await PDFNet.PageLabel.create(doc, PDFNet.PageLabel.Style.e_alphabetic_uppercase, 'My Prefix ', 1);
+          doc.setPageLabel(7, L3);
+
+          doc.save(outputFile, PDFNet.SDFDoc.SaveOptions.e_linearized);
+          console.log('Done. Result saved in newsletter_with_pagelabels.pdf...');
+        }
+
+        //-----------------------------------------------------------
+        // Example 2: Read page labels from an existing PDF document.
+        //-----------------------------------------------------------
+        {
+          const doc = await PDFNet.PDFDoc.createFromFilePath(outputFile);
+          doc.initSecurityHandler();
+
+          const page_num = await doc.getPageCount();
+          for (let i = 1; i <= page_num; ++i) {
+            console.log('Page number: ' + i);
+            const label = await doc.getPageLabel(i);
+            if (await label.isValid()) {
+              console.log(' Label: ' + await label.getLabelTitle(i));
+            }
+            else {
+              console.log(' No Label.');
+            }
+          }
+        }
+
+        //-----------------------------------------------------------
+        // Example 3: Modify page labels from an existing PDF document.
+        //-----------------------------------------------------------
+        {
+          const doc = await PDFNet.PDFDoc.createFromFilePath(outputFile);
+          doc.initSecurityHandler();
+
+          // Remove the alphabetic labels from example 1.
+          doc.removePageLabel(7);
+
+          // Replace the Prefix in the decimal labels (from example 1).
+          const label = await doc.getPageLabel(4);
+          if (await label.isValid()) {
+            await label.setPrefix('A');
+            label.setStart(1);
+          }
+
+          // Add a new label
+          const new_label = await PDFNet.PageLabel.create(doc, PDFNet.PageLabel.Style.e_decimal, 'B', 1);
+          doc.setPageLabel(10, new_label);  // starting from page 10.
+
+          doc.save(outputPath + 'newsletter_with_pagelabels_modified.pdf', PDFNet.SDFDoc.SaveOptions.e_linearized);
+          console.log('Done. Result saved in newsletter_with_pagelabels_modified.pdf...');
+
+          const page_num = await doc.getPageCount();
+          for (let i = 1; i <= page_num; ++i) {
+            console.log('Page number: ' + i);
+            const label = await doc.getPageLabel(i);
+            if (await label.isValid()) {
+              console.log(' Label: ' + await label.getLabelTitle(i));
+            }
+            else {
+              console.log(' No Label.');
+            }
+          }
+        }
+
+        //-----------------------------------------------------------
+        // Example 4: Delete all page labels in an existing PDF document.
+        //-----------------------------------------------------------
+        {
+          const doc = await PDFNet.PDFDoc.createFromFilePath(outputFile);
+          (await doc.getRoot()).eraseFromKey('PageLabels');
+        }
+
+      } 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.runPageLabelsTest();
+})(exports);
+// eslint-disable-next-line spaced-comment
 //# sourceURL=PageLabelsTest.js