@adobe/pdfservices-node-sdk
Version:
The Adobe PDF Services Node.js SDK provides APIs for creating, combining, exporting and manipulating PDFs.
100 lines • 4.72 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.ReorderPagesJob = 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 CombinePDFParams_1 = require("../params/combinepdf/CombinePDFParams");
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 allows to rearrange pages in a PDF file according to the specified order.
*
* @example
* Sample Usage:
* ```js
* const readStream = 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 inputAsset = await pdfServices.upload({
* readStream,
* mimeType: MimeType.PDF
* });
*
* const params = new ReorderPagesParams({
* asset: inputAsset,
* pageRanges: new PageRanges().addSinglePage(3).addRange(1,2)
* });
*
* const job = new ReorderPagesJob({params});
*
* const pollingURL = await pdfServices.submit({job});
*
* const pdfServicesResponse = await pdfServices.getJobResult({
* pollingURL,
* resultType: ReorderPagesResult
* });
*
* const resultAsset = pdfServicesResponse.result.asset;
* const streamAsset = await pdfServices.getContent({asset: resultAsset});
* ```
*/
class ReorderPagesJob extends PDFServicesJob_1.PDFServicesJob {
/**
* Constructs a new `ReorderPagesJob` instance.
*
* @param params The parameters for constructing an instance of `ReorderPagesJob`.
* @param params.params {@link ReorderPagesParams} object containing the input file and the page numbers in
* the order to be rearranged. 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.validateReorderPagesJobParams(params);
this._reorderPagesParams = 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.REORDER_PAGES);
return response.headers[DefaultRequestHeaders_1.DefaultRequestHeaders.LOCATION_HEADER_NAME];
}
generatePDFServicesAPIRequest(notifierConfigList) {
const combinePDFParams = new CombinePDFParams_1.CombinePDFParams().addAsset(this._reorderPagesParams.asset, this._reorderPagesParams.pageRanges);
combinePDFParams.validate();
let combinePDFRequest;
if (combinePDFParams?.assetsToCombine[0].asset instanceof CloudAsset_1.CloudAsset) {
combinePDFRequest = new CombinePDFInternalAssetRequest_1.CombinePDFInternalAssetRequest(combinePDFParams, notifierConfigList);
}
else {
combinePDFRequest = new CombinePDFExternalAssetRequest_1.CombinePDFExternalAssetRequest(combinePDFParams, this._outputAsset, notifierConfigList);
}
return combinePDFRequest;
}
}
exports.ReorderPagesJob = ReorderPagesJob;
//# sourceMappingURL=ReorderPagesJob.js.map