@pdftron/pdfnet-node-samples 10.8.0 → 10.9.0-1

package/readme.md

@@ -1,13 +1,38 @@
-## @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.
+## @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.

package/{samples/runall.bat → runall.bat}

@@ -1,12 +1,12 @@
-@echo off
-for /D %%s in (*Test) do (
-    if exist %%s\%%~nxs.js (
-        cd %%s
-        echo %%s running...
-        call node %%~nxs.js
-        cd ..
-        echo %%s finished.
-        pause
-    )
-)
-echo All tests finished.
+@echo off
+for /D %%s in (*Test) do (
+    if exist %%s\%%~nxs.js (
+        cd %%s
+        echo %%s running...
+        call node %%~nxs.js
+        cd ..
+        echo %%s finished.
+        pause
+    )
+)
+echo All tests finished.

package/{samples/runall.sh → runall.sh}

@@ -1,15 +1,15 @@
-#!/bin/sh
-
-for SAMPLE in *Test
-do
-	if [ -d $SAMPLE ] && [ -e $SAMPLE/$SAMPLE.js ]
-	then
-		cd $SAMPLE
-		echo "$SAMPLE running"
-		node $SAMPLE.js
-		cd ..
-		echo "$SAMPLE finished. Press enter to continue..."
-		read -p "$*" a
-	fi
-done
-echo "All tests finished."
+#!/bin/sh
+
+for SAMPLE in *Test
+do
+	if [ -d $SAMPLE ] && [ -e $SAMPLE/$SAMPLE.js ]
+	then
+		cd $SAMPLE
+		echo "$SAMPLE running"
+		node $SAMPLE.js
+		cd ..
+		echo "$SAMPLE finished. Press enter to continue..."
+		read -p "$*" a
+	fi
+done
+echo "All tests finished."