Skip to content

Commit

Permalink
Merge pull request #803 from AdobeDocs/release-node-sdk-4.0.0
Browse files Browse the repository at this point in the history 
added updates for Node SDK 4.0.0 release
  • Loading branch information
@hitesh-kumar-mahour
hitesh-kumar-mahour authored Mar 18, 2024
2 parents 4bdf8b9 + 214670a commit 476f0e1
Show file tree
Hide file tree
Showing 23 changed files with 2,112 additions and 1,365 deletions.
294 changes: 178 additions & 116 deletions src/pages/overview/document-generation-api/gettingstarted.md
View file

Large diffs are not rendered by default.

222 changes: 130 additions & 92 deletions src/pages/overview/document-generation-api/quickstarts/nodejs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ To get started using Adobe Document Generation API, let's walk through a simple

To complete this guide, you will need:

* [Node.js](https://nodejs.org) - Node.js version 14.0 or higher is required.
* [Node.js](https://nodejs.org) - Node.js version 18.0 or higher is required.
* An Adobe ID. If you do not have one, the credential setup will walk you through creating one.
* A way to edit code. No specific editor is required for this guide.

Expand Down Expand Up @@ -116,28 +116,22 @@ Notice how the tokens in the Word document match up with values in our JSON. Whi
3) We'll begin by including our required dependencies:

```js
const PDFServicesSdk = require('@adobe/pdfservices-node-sdk');
const fs = require('fs');
const {
ServicePrincipalCredentials,
PDFServices,
MimeType,
DocumentMergeParams,
OutputFormat,
DocumentMergeJob,
DocumentMergeResult,
SDKError,
ServiceUsageError,
ServiceApiError
} = require("@adobe/pdfservices-node-sdk");
const fs = require("fs");
```

The first line includes the Adobe PDF Services Node.js SDK. The second third include Node's `filesystem` package.

2) Now let's define our input and output:

```js
const OUTPUT = './generatedReceipt.pdf';

// If our output already exists, remove it so we can run the application again.
if(fs.existsSync(OUTPUT)) fs.unlinkSync(OUTPUT);

const INPUT = './receiptTemplate.docx';

const JSON_INPUT = require('./receipt.json');
```

These lines are hard coded but in a real application would typically be dynamic.

3) Set the environment variables `PDF_SERVICES_CLIENT_ID` and `PDF_SERVICES_CLIENT_SECRET` by running the following commands and replacing placeholders `YOUR CLIENT ID` and `YOUR CLIENT SECRET` with the credentials present in `pdfservices-api-credentials.json` file:
4) Set the environment variables `PDF_SERVICES_CLIENT_ID` and `PDF_SERVICES_CLIENT_SECRET` by running the following commands and replacing placeholders `YOUR CLIENT ID` and `YOUR CLIENT SECRET` with the credentials present in `pdfservices-api-credentials.json` file:
- **Windows:**
- `set PDF_SERVICES_CLIENT_ID=<YOUR CLIENT ID>`
- `set PDF_SERVICES_CLIENT_SECRET=<YOUR CLIENT SECRET>`
Expand All @@ -146,109 +140,153 @@ These lines are hard coded but in a real application would typically be dynamic.
- `export PDF_SERVICES_CLIENT_ID=<YOUR CLIENT ID>`
- `export PDF_SERVICES_CLIENT_SECRET=<YOUR CLIENT SECRET>`

4) Next, we setup the SDK to use our credentials.
5) Next, we setup the SDK to use our credentials.

```js
const credentials = PDFServicesSdk.Credentials
.servicePrincipalCredentialsBuilder()
.withClientId(process.env.PDF_SERVICES_CLIENT_ID)
.withClientSecret(process.env.PDF_SERVICES_CLIENT_SECRET)
.build();

// Create an ExecutionContext using credentials
const executionContext = PDFServicesSdk.ExecutionContext.create(credentials);
```
// Initial setup, create credentials instance
const credentials = new ServicePrincipalCredentials({
clientId: process.env.PDF_SERVICES_CLIENT_ID,
clientSecret: process.env.PDF_SERVICES_CLIENT_SECRET
});

This code both points to the credentials downloaded previously as well as sets up an execution context object that will be used later.
// Creates a PDF Services instance
const pdfServices = new PDFServices({credentials});
```

5) Now, let's create the operation:
6) Now, let's upload the asset and create JSON data for merge:

```js
const documentMerge = PDFServicesSdk.DocumentMerge,
documentMergeOptions = documentMerge.options,
options = new documentMergeOptions.DocumentMergeOptions(JSON_INPUT, documentMergeOptions.OutputFormat.PDF);
// Creates an asset(s) from source file(s) and upload
readStream = fs.createReadStream("./receiptTemplate.docx");
const inputAsset = await pdfServices.upload({
readStream,
mimeType: MimeType.DOCX
});

// Setup input data for the document merge process
const jsonDataForMerge = JSON.parse(fs.readFileSync('./receipt.json', 'utf-8'));
```

// Create a new operation instance using the options instance.
const documentMergeOperation = documentMerge.Operation.createNew(options);
7) Now, let's create the parameters and the job:

// Set operation input document template from a source file.
const input = PDFServicesSdk.FileRef.createFromLocalFile(INPUT);
documentMergeOperation.setInput(input);
```js
// Create parameters for the job
const params = new DocumentMergeParams({
jsonDataForMerge,
outputFormat: OutputFormat.PDF
});

// Creates a new job instance
const job = new DocumentMergeJob({inputAsset, params});
```

This set of code defines what we're doing (a document merge operation, the SDK's way of describing Document Generation), points to our local JSON file and specifies the output is a PDF. It also points to the Word file used as a template.

6) The next code block executes the operation:
8) The next code block submits the job and gets the job result:

```js
// Execute the operation and Save the result to the specified location.
documentMergeOperation.execute(executionContext)
.then(result => result.saveAsFile(OUTPUT))
.catch(err => {
if(err instanceof PDFServicesSdk.Error.ServiceApiError
|| err instanceof PDFServicesSdk.Error.ServiceUsageError) {
console.log('Exception encountered while executing operation', err);
} else {
console.log('Exception encountered while executing operation', err);
}
// Submit the job and get the job result
const pollingURL = await pdfServices.submit({job});
const pdfServicesResponse = await pdfServices.getJobResult({
pollingURL,
resultType: DocumentMergeResult
});
```

This code runs the document generation process and then stores the result PDF document to the file system.

![Example running at the command line](./shot9.png)
// Get content from the resulting asset(s)
const resultAsset = pdfServicesResponse.result.asset;
const streamAsset = await pdfServices.getContent({asset: resultAsset});
```

Here's the complete application (`documentmerge.js`):
9) The next code block saves the result at the specified location:

```js
const PDFServicesSdk = require('@adobe/pdfservices-node-sdk');
const fs = require('fs');

const OUTPUT = './generatedReceipt.pdf';
// Creates a write stream and copy stream asset's content to it
const outputFilePath = "./generatePDFOutput.pdf";
console.log(`Saving asset at ${outputFilePath}`);

// If our output already exists, remove it so we can run the application again.
if(fs.existsSync(OUTPUT)) fs.unlinkSync(OUTPUT);
const writeStream = fs.createWriteStream(outputFilePath);
streamAsset.readStream.pipe(writeStream);
```

const INPUT = './receiptTemplate.docx';
This code runs the Document Generation process and then stores the resulting PDF document to the file system.

const JSON_INPUT = require('./receipt.json');
![Example running at the command line](./shot9.png)

Here's the complete application (`documentmerge.js`):

// Set up our credentials object.
const credentials = PDFServicesSdk.Credentials
.servicePrincipalCredentialsBuilder()
.withClientId(process.env.PDF_SERVICES_CLIENT_ID)
.withClientSecret(process.env.PDF_SERVICES_CLIENT_SECRET)
.build();
```js
const {
ServicePrincipalCredentials,
PDFServices,
MimeType,
DocumentMergeParams,
OutputFormat,
DocumentMergeJob,
DocumentMergeResult,
SDKError,
ServiceUsageError,
ServiceApiError
} = require("@adobe/pdfservices-node-sdk");
const fs = require("fs");

(async () => {
let readStream;
try {
// Initial setup, create credentials instance
const credentials = new ServicePrincipalCredentials({
clientId: process.env.PDF_SERVICES_CLIENT_ID,
clientSecret: process.env.PDF_SERVICES_CLIENT_SECRET
});

// Create an ExecutionContext using credentials
const executionContext = PDFServicesSdk.ExecutionContext.create(credentials);
// Creates a PDF Services instance
const pdfServices = new PDFServices({credentials});

// This creates an instance of the Export operation we're using, as well as specifying output type (DOCX)
const documentMerge = PDFServicesSdk.DocumentMerge,
documentMergeOptions = documentMerge.options,
options = new documentMergeOptions.DocumentMergeOptions(JSON_INPUT, documentMergeOptions.OutputFormat.PDF);
// Creates an asset(s) from source file(s) and upload
readStream = fs.createReadStream("./receiptTemplate.docx");
const inputAsset = await pdfServices.upload({
readStream,
mimeType: MimeType.DOCX
});

// Create a new operation instance using the options instance.
const documentMergeOperation = documentMerge.Operation.createNew(options);
// Setup input data for the document merge process
const jsonDataForMerge = JSON.parse(fs.readFileSync('./receipt.json', 'utf-8'));

// Set operation input document template from a source file.
const input = PDFServicesSdk.FileRef.createFromLocalFile(INPUT);
documentMergeOperation.setInput(input);
// Create parameters for the job
const params = new DocumentMergeParams({
jsonDataForMerge,
outputFormat: OutputFormat.PDF
});

// Creates a new job instance
const job = new DocumentMergeJob({inputAsset, params});

// Execute the operation and Save the result to the specified location.
documentMergeOperation.execute(executionContext)
.then(result => result.saveAsFile(OUTPUT))
.catch(err => {
if(err instanceof PDFServicesSdk.Error.ServiceApiError
|| err instanceof PDFServicesSdk.Error.ServiceUsageError) {
console.log('Exception encountered while executing operation', err);
} else {
console.log('Exception encountered while executing operation', err);
}
// Submit the job and get the job result
const pollingURL = await pdfServices.submit({job});
const pdfServicesResponse = await pdfServices.getJobResult({
pollingURL,
resultType: DocumentMergeResult
});

// Get content from the resulting asset(s)
const resultAsset = pdfServicesResponse.result.asset;
const streamAsset = await pdfServices.getContent({asset: resultAsset});

// Creates a write stream and copy stream asset's content to it
const outputFilePath = "./generatePDFOutput.pdf";
console.log(`Saving asset at ${outputFilePath}`);

const writeStream = fs.createWriteStream(outputFilePath);
streamAsset.readStream.pipe(writeStream);
} catch (err) {
if (err instanceof SDKError || err instanceof ServiceUsageError || err instanceof ServiceApiError) {
console.log("Exception encountered while executing operation", err);
} else {
console.log("Exception encountered while executing operation", err);
}
} finally {
readStream?.destroy();
}
})();
```
## Next Steps
Expand Down
Binary file modified src/pages/overview/document-generation-api/quickstarts/nodejs/shot9.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion src/pages/overview/legacy-documentation/pdf-extract-api/quickstarts.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ After downloading the zip, you can either run the samples in the zip directly, o

Running any sample or custom code requires the following steps:

1. Install [Node.js 14.0](https://nodejs.org/en/download/) or higher.
1. Install [Node.js 18.0](https://nodejs.org/en/download/) or higher.

<InlineAlert slots="text"/>

Expand Down
2 changes: 1 addition & 1 deletion src/pages/overview/pdf-accessibility-auto-tag-api/gettingstarted.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -472,7 +472,7 @@ After downloading the zip, you can run the samples in the zip directly by settin

Running any sample or custom code requires the following steps:

1. Install [Node.js 14.0](https://nodejs.org/en/download/) or higher.
1. Install [Node.js 18.0](https://nodejs.org/en/download/) or higher.

<InlineAlert slots="text"/>

Expand Down
Loading

0 comments on commit 476f0e1

Please sign in to comment.