@adobe/pdfservices-node-sdk
Version:
The Adobe PDF Services Node.js SDK provides APIs for creating, combining, exporting and manipulating PDFs.
104 lines • 4.96 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.RotatePagesJob = 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 PageManipulationInternalAssetRequest_1 = require("../../internal/dto/request/pagemanipulation/PageManipulationInternalAssetRequest");
const PageManipulationExternalAssetRequest_1 = require("../../internal/dto/request/pagemanipulation/PageManipulationExternalAssetRequest");
const PageActionCommand_1 = require("../../internal/dto/request/pagemanipulation/PageActionCommand");
const PDFServicesHelper_1 = require("../../internal/PDFServicesHelper");
/**
* A job that allows rotation of specific pages in a PDF file.
*
* @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 RotatePagesParams()
* .setAngleToRotatePagesBy(Angle._90);
*
* const job = new RotatePagesJob({inputAsset, params});
*
* const pollingURL = await pdfServices.submit({job});
*
* const pdfServicesResponse = await pdfServices.getJobResult({
* pollingURL,
* resultType: RotatePagesResult
* });
*
* const resultAsset = pdfServicesResponse.result.asset;
* const streamAsset = await pdfServices.getContent({asset: resultAsset});
* ```
*/
class RotatePagesJob extends PDFServicesJob_1.PDFServicesJob {
/**
* Constructs a new `RotatePagesJob` instance.
*
* @param params The parameters for constructing an instance of `RotatePagesJob`.
* @param params.inputAsset The input asset for the job. Cannot be undefined.
* @param params.params {@link RotatePagesParams} object containing the rotation angle and page ranges.
* 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.validateRotatePagesJobParams(params);
this._inputAsset = params.inputAsset;
this._rotatePagesParams = params.params;
this._outputAsset = params.outputAsset;
}
/**
* @hidden
*/
async process(executionContext, notifierConfigList) {
this.validate(executionContext);
const rotatePagesRequest = this.generatePDFServicesAPIRequest(notifierConfigList), xRequestId = (0, uuid_1.v4)(), response = await PDFServicesHelper_1.PDFServicesHelper.submitJob(executionContext, rotatePagesRequest, xRequestId, OperationHeaderInfoEndpointMap_1.OperationHeaderInfoEndpointMap.ROTATE_PAGES);
return response.headers[DefaultRequestHeaders_1.DefaultRequestHeaders.LOCATION_HEADER_NAME];
}
generatePDFServicesAPIRequest(notifierConfigList) {
let pageManipulationRequest;
if (this._inputAsset instanceof CloudAsset_1.CloudAsset) {
pageManipulationRequest = new PageManipulationInternalAssetRequest_1.PageManipulationInternalAssetRequest(this._inputAsset.assetId, this.getPageActionCommands(), notifierConfigList);
}
else {
pageManipulationRequest = new PageManipulationExternalAssetRequest_1.PageManipulationExternalAssetRequest(this._inputAsset, this.getPageActionCommands(), this._outputAsset, notifierConfigList);
}
return pageManipulationRequest;
}
getPageActionCommands() {
const pageActionCommands = [];
for (const pageAction of this._rotatePagesParams.pageActions)
pageActionCommands.push(PageActionCommand_1.PageActionCommand.createFrom(pageAction));
return pageActionCommands;
}
}
exports.RotatePagesJob = RotatePagesJob;
//# sourceMappingURL=RotatePagesJob.js.map