@adobe/pdfservices-node-sdk
Version:
The Adobe PDF Services Node.js SDK provides APIs for creating, combining, exporting and manipulating PDFs.
102 lines • 4.68 kB
JavaScript
;
/*
* Copyright 2024 Adobe
* All Rights Reserved.
*
* NOTICE: Adobe permits you to use, modify, and distribute this file in
* accordance with the terms of the Adobe license agreement accompanying
* it. If you have received this file from a source other than Adobe,
* then your use, modification, or distribution of it requires the prior
* written permission of Adobe.
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.CombinePDFJob = void 0;
const uuid_1 = require("uuid");
const PDFServicesJob_1 = require("./PDFServicesJob");
const ValidationUtil_1 = require("../../internal/util/ValidationUtil");
const OperationHeaderInfoEndpointMap_1 = require("../../internal/constants/OperationHeaderInfoEndpointMap");
const DefaultRequestHeaders_1 = require("../../internal/http/DefaultRequestHeaders");
const CloudAsset_1 = require("../../io/CloudAsset");
const CombinePDFInternalAssetRequest_1 = require("../../internal/dto/request/combinepdf/CombinePDFInternalAssetRequest");
const CombinePDFExternalAssetRequest_1 = require("../../internal/dto/request/combinepdf/CombinePDFExternalAssetRequest");
const PDFServicesHelper_1 = require("../../internal/PDFServicesHelper");
/**
* A job that combines multiple PDF files into a single PDF file. Allows specifying which pages of the source files
* to combine.
*
* @example
* Sample Usage:
* ```js
* const readStream1 = fs.createReadStream("<SOURCE_PATH>");
* const readStream2 = fs.createReadStream("<SOURCE_PATH>");
*
* const credentials = new ServicePrincipalCredentials({
* clientId: process.env.PDF_SERVICES_CLIENT_ID,
* clientSecret: process.env.PDF_SERVICES_CLIENT_SECRET
* });
*
* const pdfServices = new PDFServices({credentials});
*
* const [inputAsset1, inputAsset2] = await pdfServices.uploadAssets({
* streamAssets: [{
* readStream: readStream1,
* mimeType: MimeType.PDF
* }, {
* readStream: readStream2,
* mimeType: MimeType.PDF
* }]
* });
*
* const params = new CombinePDFParams()
* .addAsset(inputAsset1)
* .addAsset(inputAsset2);
*
* const job = new CombinePDFJob({params});
*
* const pollingURL = await pdfServices.submit({job});
*
* const pdfServicesResponse = await pdfServices.getJobResult({
* pollingURL,
* resultType: CombinePDFResult
* });
*
* const resultAsset = pdfServicesResponse.result.asset;
* const streamAsset = await pdfServices.getContent({asset: resultAsset});
* ```
*/
class CombinePDFJob extends PDFServicesJob_1.PDFServicesJob {
/**
* Constructs a new `CombinePDFJob` instance.
* @param params The parameters for constructing an instance of `CombinePDFJob`.
* @param params.params {@link CombinePDFParams} object containing the input files and the page ranges to be
* combined. Cannot be undefined.
* @param [params.outputAsset] {@link Asset} object representing the output asset.
* @remarks External assets can be set as output only when input is external asset as well.
*/
constructor(params) {
super();
ValidationUtil_1.ValidationUtil.validateCombinePDFJobParams(params);
this._combinePDFParams = params.params;
this._outputAsset = params.outputAsset;
}
/**
* @hidden
*/
async process(executionContext, notifierConfigList) {
this.validate(executionContext);
const combinePDFRequest = this.generatePDFServicesAPIRequest(notifierConfigList), xRequestId = (0, uuid_1.v4)(), response = await PDFServicesHelper_1.PDFServicesHelper.submitJob(executionContext, combinePDFRequest, xRequestId, OperationHeaderInfoEndpointMap_1.OperationHeaderInfoEndpointMap.COMBINE_PDF);
return response.headers[DefaultRequestHeaders_1.DefaultRequestHeaders.LOCATION_HEADER_NAME];
}
generatePDFServicesAPIRequest(notifierConfigList) {
let combinePDFRequest;
if (this._combinePDFParams.assetsToCombine[0].asset instanceof CloudAsset_1.CloudAsset) {
combinePDFRequest = new CombinePDFInternalAssetRequest_1.CombinePDFInternalAssetRequest(this._combinePDFParams, notifierConfigList);
}
else {
combinePDFRequest = new CombinePDFExternalAssetRequest_1.CombinePDFExternalAssetRequest(this._combinePDFParams, this._outputAsset, notifierConfigList);
}
return combinePDFRequest;
}
}
exports.CombinePDFJob = CombinePDFJob;
//# sourceMappingURL=CombinePDFJob.js.map