@pdftron/pdfnet-node-samples 10.9.0-2-beta → 10.9.0

package/package.json

@@ -1,20 +1,21 @@
-{
-  "name": "@pdftron/pdfnet-node-samples",
-  "version": "10.9.0-2-beta",
-  "description": "Sample code for the @pdftron/pdfnet-node package.",
-  "scripts": {
-    "test": "run-script-os",
-    "test:darwin:linux": "cd samples && sh runall.sh",
-    "test:win32": "cd samples && runall.bat",
-    "test:default": "echo '@pdftron/pdfnet-node doesn't support this platform.'"
-  },
-  "author": "Apryse Software Inc.",
-  "license": "Commercial",
-  "homepage": "https://www.pdftron.com",
-  "dependencies": {
-    "@pdftron/pdfnet-node": "^10.9.0-2-beta",
-    "run-script-os": "^1.1.6",
-    "underscore": "^1.13.6",
-    "xhr2": "^0.2.1"
-  }
-}
+{
+  "name": "@pdftron/pdfnet-node-samples",
+  "version": "10.9.0",
+  "description": "Sample code for the @pdftron/pdfnet-node package.",
+  "scripts": {
+    "test": "run-script-os",
+    "test:darwin:linux": "cd samples && sh runall.sh",
+    "test:win32": "cd samples && runall.bat",
+    "test:default": "echo '@pdftron/pdfnet-node doesn't support this platform.'"
+  },
+  "author": "Apryse Software Inc.",
+  "license": "Commercial",
+  "homepage": "https://www.pdftron.com",
+  "dependencies": {
+    "@pdftron/pdfnet-node": "^10.6.0-4",
+    "run-script-os": "^1.1.6",
+    "underscore": "^1.13.6",
+    "xhr2": "^0.2.1"
+  }
+}
+

package/readme.md

@@ -1,38 +1,13 @@
-## @pdftron/pdfnet-node
-
-This package leverages the full power of Apryse's native SDK for maximal performance and accuracy. In order to maintain consistency across platforms the Javascript API is used in the same manner as the PDFNet API available in Apryse's Web platform. Since access to the filesystem is included in Node.js/Electron some additional APIs requiring filesystem access have also been included.
-
-#### Supported platform, Node.js, and Electron versions
-This package depends on unmanaged add-on binaries, and the add-on binaries are not cross-platform. At the moment we have support for
-  * **OS**: Linux (excluding Alpine), Windows(x64), Mac
-  * **Node.js version**: 8 - 21
-  * **Electron version**: 26 - 26
- 
-Installation will fail if your OS, Node.js or Electron version is not supported.
-
-To install for Electron, *runtime* and *target* options are needed. For example, For Electron 6, we need to run  *npm i @pdftron/pdfnet-node --runtime=electron --target=6.0.0*. Note that we need to use *6.0.0* for all Electron 6 versions.
-
-#### Usage
-Here is a code snippet to demonstrate how to use this package.
-```javascript
-const { PDFNet } = require('@pdftron/pdfnet-node');  // you may need to set up NODE_PATH environment variable to make this work.
-
-const main = async() => {
-  const doc = await PDFNet.PDFDoc.create();
-  const page = await doc.pageCreate();
-  doc.pagePushBack(page);
-  doc.save('blank.pdf', PDFNet.SDFDoc.SaveOptions.e_linearized);
-};
-
-// add your own license key as the second parameter, e.g. in place of 'YOUR_LICENSE_KEY'.
-PDFNet.runWithCleanup(main, 'YOUR_LICENSE_KEY').catch(function(error) {
-  console.log('Error: ' + JSON.stringify(error));
-}).then(function(){ return PDFNet.shutdown(); });
-```
-
-There are some code samples in the [@pdftron/pdfnet-node-samples](https://www.npmjs.com/package/@pdftron/pdfnet-node-samples) package.
-
-To get started please see the documentation at https://www.apryse.com/documentation/nodejs/get-started/integration.
-
-#### Licensing
-Please go to https://www.apryse.com/pws/get-key to obtain a demo license or https://wwww.apryse.com/form/contact-sales to obtain a production key. For further information, please visit https://www.apryse.com/licensing.
+## @pdftron/pdfnet-node-samples
+
+This package contains sample code for [@pdftron/pdfnet-node](https://www.npmjs.com/package/@pdftron/pdfnet-node).
+
+#### Run the samples
+Please enter your license key by replacing the LicenseKey variable value in *@pdftron/pdfnet-node-samples/samples/LicenseKey/LicenseKey.js*.
+
+Run `npm run test` in the *@pdftron/pdfnet-node-samples* directory to run all the samples.
+
+The samples are in the *@pdftron/pdfnet-node-samples/samples* directory after the installation for Node.js.
+
+#### Licensing
+Please go to https://www.pdftron.com/pws/get-key to obtain a demo license or https://www.pdftron.com/form/contact-sales to obtain a production key. For further information, please visit  https://www.pdftron.com/licensing.

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

@@ -1,116 +1,116 @@
-//---------------------------------------------------------------------------------------
-// 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.runAddImageTest = () => {
-
-    const main = async() => {
-      try {
-        // Relative path to the folder containing test files.
-        const inputURL = '../TestFiles/';
-
-        const doc = await PDFNet.PDFDoc.create();
-        doc.initSecurityHandler();
-
-        const builder = await PDFNet.ElementBuilder.create(); // ElementBuilder, used to build new element Objects
-        // create a new page writer that allows us to add/change page elements
-        const writer = await PDFNet.ElementWriter.create(); // ElementWriter, used to write elements to the page
-        // define new page dimensions
-        let page = await doc.pageCreate();
-
-        writer.beginOnPage(page, PDFNet.ElementWriter.WriteMode.e_overlay);
-
-        // Adding a JPEG image to output file
-        let img = await PDFNet.Image.createFromFile(doc, inputURL + 'peppers.jpg');
-        let imgWidth = await img.getImageWidth();
-        let imgHeight = await img.getImageHeight();
-        let element = await builder.createImageScaled(img, 50, 500, imgWidth/2, imgHeight/2);
-        writer.writePlacedElement(element);
-
-        // Add a PNG to output file
-        img = await PDFNet.Image.createFromFile(doc, inputURL + 'butterfly.png');
-        matrix = await PDFNet.Matrix2D.create(100, 0, 0, 100, 300, 500);
-        element = await builder.createImageFromMatrix(img, matrix);
-        writer.writePlacedElement(element);
-
-        // Add a GIF image to the output file
-        img = await PDFNet.Image.createFromFile(doc, inputURL + 'pdfnet.gif');
-        imgWidth = await img.getImageWidth();
-        imgHeight = await img.getImageHeight();
-        matrix = await PDFNet.Matrix2D.create(imgWidth, 0, 0, imgHeight, 50, 350);
-        element = await builder.createImageFromMatrix(img, matrix);
-        writer.writePlacedElement(element);
-
-        // Add a TIFF image to the output file
-        img = await PDFNet.Image.createFromFile(doc, inputURL + 'grayscale.tif');
-        imgWidth = await img.getImageWidth();
-        imgHeight = await img.getImageHeight();
-        matrix = await PDFNet.Matrix2D.create(imgWidth, 0, 0, imgHeight, 10, 50);
-        element = await builder.createImageFromMatrix(img, matrix);
-        writer.writePlacedElement(element);
-
-        writer.end();
-        doc.pagePushBack(page);
-
-        // Embed monochrome TIFF compressed using lossy JBIG2 filter
-        const pageRect = await PDFNet.Rect.init(0, 0, 612, 794);
-        page = await doc.pageCreate(pageRect);
-        writer.beginOnPage(page);
-
-        const hintSet = await PDFNet.ObjSet.create();
-        const enc = await hintSet.createArray();
-        await enc.pushBackName('JBIG2');
-        await enc.pushBackName('Lossy');
-
-        img = await PDFNet.Image.createFromFile(doc, inputURL + 'multipage.tif', enc);
-        matrix = await PDFNet.Matrix2D.create(612, 0, 0, 794, 0, 0);
-        element = await builder.createImageFromMatrix(img, matrix);
-        writer.writePlacedElement(element);
-
-        writer.end();
-        doc.pagePushBack(page);
-
-        // Add a JPEG200 to output file
-        page = await doc.pageCreate();
-        writer.beginOnPage(page);
-
-        img = await PDFNet.Image.createFromFile(doc, inputURL + 'palm.jp2');
-        imgWidth = await img.getImageWidth();
-        imgHeight = await img.getImageHeight();
-        matrix = await PDFNet.Matrix2D.create(imgWidth, 0, 0, imgHeight, 96, 80);
-        element = await builder.createImageFromMatrix(img, matrix);
-        writer.writePlacedElement(element);
-
-        // write 'JPEG2000 Sample' text under image
-        const timesFont = await PDFNet.Font.create(doc, PDFNet.Font.StandardType1Font.e_times_roman);
-        writer.writeElement(await builder.createTextBeginWithFont(timesFont, 32));
-        element = await builder.createNewTextRun('JPEG2000 Sample');
-        matrix = await PDFNet.Matrix2D.create(1, 0, 0, 1, 190, 30);
-        await element.setTextMatrix(matrix);
-        writer.writeElement(element);
-        const element2 = await builder.createTextEnd();
-        writer.writeElement(element2);
-
-        await writer.end();
-        doc.pagePushBack(page); // add the page to the document
-
-        await doc.save(inputURL + 'Output/addimage.pdf', PDFNet.SDFDoc.SaveOptions.e_linearized);
-
-        console.log('Done. Result saved in addimage.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.runAddImageTest();
-})(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.runAddImageTest = () => {
+
+    const main = async() => {
+      try {
+        // Relative path to the folder containing test files.
+        const inputURL = '../TestFiles/';
+
+        const doc = await PDFNet.PDFDoc.create();
+        doc.initSecurityHandler();
+
+        const builder = await PDFNet.ElementBuilder.create(); // ElementBuilder, used to build new element Objects
+        // create a new page writer that allows us to add/change page elements
+        const writer = await PDFNet.ElementWriter.create(); // ElementWriter, used to write elements to the page
+        // define new page dimensions
+        let page = await doc.pageCreate();
+
+        writer.beginOnPage(page, PDFNet.ElementWriter.WriteMode.e_overlay);
+
+        // Adding a JPEG image to output file
+        let img = await PDFNet.Image.createFromFile(doc, inputURL + 'peppers.jpg');
+        let imgWidth = await img.getImageWidth();
+        let imgHeight = await img.getImageHeight();
+        let element = await builder.createImageScaled(img, 50, 500, imgWidth/2, imgHeight/2);
+        writer.writePlacedElement(element);
+
+        // Add a PNG to output file
+        img = await PDFNet.Image.createFromFile(doc, inputURL + 'butterfly.png');
+        matrix = await PDFNet.Matrix2D.create(100, 0, 0, 100, 300, 500);
+        element = await builder.createImageFromMatrix(img, matrix);
+        writer.writePlacedElement(element);
+
+        // Add a GIF image to the output file
+        img = await PDFNet.Image.createFromFile(doc, inputURL + 'pdfnet.gif');
+        imgWidth = await img.getImageWidth();
+        imgHeight = await img.getImageHeight();
+        matrix = await PDFNet.Matrix2D.create(imgWidth, 0, 0, imgHeight, 50, 350);
+        element = await builder.createImageFromMatrix(img, matrix);
+        writer.writePlacedElement(element);
+
+        // Add a TIFF image to the output file
+        img = await PDFNet.Image.createFromFile(doc, inputURL + 'grayscale.tif');
+        imgWidth = await img.getImageWidth();
+        imgHeight = await img.getImageHeight();
+        matrix = await PDFNet.Matrix2D.create(imgWidth, 0, 0, imgHeight, 10, 50);
+        element = await builder.createImageFromMatrix(img, matrix);
+        writer.writePlacedElement(element);
+
+        writer.end();
+        doc.pagePushBack(page);
+
+        // Embed monochrome TIFF compressed using lossy JBIG2 filter
+        const pageRect = await PDFNet.Rect.init(0, 0, 612, 794);
+        page = await doc.pageCreate(pageRect);
+        writer.beginOnPage(page);
+
+        const hintSet = await PDFNet.ObjSet.create();
+        const enc = await hintSet.createArray();
+        await enc.pushBackName('JBIG2');
+        await enc.pushBackName('Lossy');
+
+        img = await PDFNet.Image.createFromFile(doc, inputURL + 'multipage.tif', enc);
+        matrix = await PDFNet.Matrix2D.create(612, 0, 0, 794, 0, 0);
+        element = await builder.createImageFromMatrix(img, matrix);
+        writer.writePlacedElement(element);
+
+        writer.end();
+        doc.pagePushBack(page);
+
+        // Add a JPEG200 to output file
+        page = await doc.pageCreate();
+        writer.beginOnPage(page);
+
+        img = await PDFNet.Image.createFromFile(doc, inputURL + 'palm.jp2');
+        imgWidth = await img.getImageWidth();
+        imgHeight = await img.getImageHeight();
+        matrix = await PDFNet.Matrix2D.create(imgWidth, 0, 0, imgHeight, 96, 80);
+        element = await builder.createImageFromMatrix(img, matrix);
+        writer.writePlacedElement(element);
+
+        // write 'JPEG2000 Sample' text under image
+        const timesFont = await PDFNet.Font.create(doc, PDFNet.Font.StandardType1Font.e_times_roman);
+        writer.writeElement(await builder.createTextBeginWithFont(timesFont, 32));
+        element = await builder.createNewTextRun('JPEG2000 Sample');
+        matrix = await PDFNet.Matrix2D.create(1, 0, 0, 1, 190, 30);
+        await element.setTextMatrix(matrix);
+        writer.writeElement(element);
+        const element2 = await builder.createTextEnd();
+        writer.writeElement(element2);
+
+        await writer.end();
+        doc.pagePushBack(page); // add the page to the document
+
+        await doc.save(inputURL + 'Output/addimage.pdf', PDFNet.SDFDoc.SaveOptions.e_linearized);
+
+        console.log('Done. Result saved in addimage.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.runAddImageTest();
+})(exports);
+// eslint-disable-next-line spaced-comment
 //# sourceURL=AddImageTest.js

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

@@ -1,78 +1,78 @@
-//---------------------------------------------------------------------------------------
-// Copyright (c) 2001-2024 by Apryse Software Inc. All Rights Reserved.
-// Consult legal.txt regarding legal and license information.
-//---------------------------------------------------------------------------------------
-
-//---------------------------------------------------------------------------------------
-// The following sample illustrates how to convert AdvancedImaging documents to PDF format 
-// 
-// The AdvancedImaging module is an optional PDFNet Add-on that can be used to convert AdvancedImaging
-// documents into PDF documents
-//
-// The Apryse SDK AdvancedImaging module can be downloaded from http://www.pdftron.com/
-//---------------------------------------------------------------------------------------
-
-const { PDFNet } = require('@pdftron/pdfnet-node');
-const PDFTronLicense = require('../LicenseKey/LicenseKey');
-
-((exports) => {
-	'use strict';
-
-	exports.runAdvancedImagingTest = () => {
-
-		const main = async () => {
-
-			try {
-				await PDFNet.addResourceSearchPath('../../lib/');
-
-				if (!await PDFNet.AdvancedImagingModule.isModuleAvailable()) {
-					console.log('\nUnable to run AdvancedImagingTest: Apryse SDK AdvancedImaging module not available.');
-					console.log('---------------------------------------------------------------');
-					console.log('The AdvancedImaging 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/AdvancedImaging/';
-				const outputPath = '../TestFiles/Output/';
-
-				const dicom_input_file = 'xray.dcm';
-				const heic_input_file = 'jasper.heic';
-				const psd_input_file = 'tiger.psd';
-				const output_ext = '.pdf';
-				
-				const doc = await PDFNet.PDFDoc.create();
-				doc.initSecurityHandler();
-
-				const opts = new PDFNet.Convert.AdvancedImagingConvertOptions();
-				opts.setDefaultDPI(72);
-				await PDFNet.Convert.fromDICOM(doc, inputPath + dicom_input_file, opts);
-				await doc.save(outputPath + dicom_input_file + output_ext, PDFNet.SDFDoc.SaveOptions.e_linearized);
-
-				const doc2 = await PDFNet.PDFDoc.create();
-				doc2.initSecurityHandler();
-
-				await PDFNet.Convert.toPdf(doc2, inputPath + heic_input_file);
-				await doc2.save(outputPath + heic_input_file + output_ext, PDFNet.SDFDoc.SaveOptions.e_linearized);
-
-				const doc3 = await PDFNet.PDFDoc.create();
-				doc3.initSecurityHandler();
-
-				await PDFNet.Convert.toPdf(doc3, inputPath + psd_input_file);
-				await doc3.save(outputPath + psd_input_file + output_ext, 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.runAdvancedImagingTest();
-})(exports);
-// eslint-disable-next-line spaced-comment
-//# sourceURL=AdvancedImagingTest.js
+//---------------------------------------------------------------------------------------
+// Copyright (c) 2001-2024 by Apryse Software Inc. All Rights Reserved.
+// Consult legal.txt regarding legal and license information.
+//---------------------------------------------------------------------------------------
+
+//---------------------------------------------------------------------------------------
+// The following sample illustrates how to convert AdvancedImaging documents to PDF format 
+// 
+// The AdvancedImaging module is an optional PDFNet Add-on that can be used to convert AdvancedImaging
+// documents into PDF documents
+//
+// The Apryse SDK AdvancedImaging module can be downloaded from http://www.pdftron.com/
+//---------------------------------------------------------------------------------------
+
+const { PDFNet } = require('@pdftron/pdfnet-node');
+const PDFTronLicense = require('../LicenseKey/LicenseKey');
+
+((exports) => {
+	'use strict';
+
+	exports.runAdvancedImagingTest = () => {
+
+		const main = async () => {
+
+			try {
+				await PDFNet.addResourceSearchPath('../../lib/');
+
+				if (!await PDFNet.AdvancedImagingModule.isModuleAvailable()) {
+					console.log('\nUnable to run AdvancedImagingTest: Apryse SDK AdvancedImaging module not available.');
+					console.log('---------------------------------------------------------------');
+					console.log('The AdvancedImaging 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/AdvancedImaging/';
+				const outputPath = '../TestFiles/Output/';
+
+				const dicom_input_file = 'xray.dcm';
+				const heic_input_file = 'jasper.heic';
+				const psd_input_file = 'tiger.psd';
+				const output_ext = '.pdf';
+				
+				const doc = await PDFNet.PDFDoc.create();
+				doc.initSecurityHandler();
+
+				const opts = new PDFNet.Convert.AdvancedImagingConvertOptions();
+				opts.setDefaultDPI(72);
+				await PDFNet.Convert.fromDICOM(doc, inputPath + dicom_input_file, opts);
+				await doc.save(outputPath + dicom_input_file + output_ext, PDFNet.SDFDoc.SaveOptions.e_linearized);
+
+				const doc2 = await PDFNet.PDFDoc.create();
+				doc2.initSecurityHandler();
+
+				await PDFNet.Convert.toPdf(doc2, inputPath + heic_input_file);
+				await doc2.save(outputPath + heic_input_file + output_ext, PDFNet.SDFDoc.SaveOptions.e_linearized);
+
+				const doc3 = await PDFNet.PDFDoc.create();
+				doc3.initSecurityHandler();
+
+				await PDFNet.Convert.toPdf(doc3, inputPath + psd_input_file);
+				await doc3.save(outputPath + psd_input_file + output_ext, 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.runAdvancedImagingTest();
+})(exports);
+// eslint-disable-next-line spaced-comment
+//# sourceURL=AdvancedImagingTest.js