@adobe/pdfservices-node-sdk
Version:
The Adobe PDF Services Node.js SDK provides APIs for creating, combining, exporting and manipulating PDFs.
100 lines • 4.46 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.SplitPDFJob = 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 SplitPDFInternalAssetRequest_1 = require("../../internal/dto/request/splitpdf/SplitPDFInternalAssetRequest");
const PDFServicesHelper_1 = require("../../internal/PDFServicesHelper");
const SplitPDFExternalAssetRequest_1 = require("../../internal/dto/request/splitpdf/SplitPDFExternalAssetRequest");
/**
* A job that splits PDF document into multiple smaller documents by simply specifying either the number of files,
* pages per file, or page ranges.
*
* @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 SplitPDFParams({
* pageCount: 2
* });
*
* const job = new SplitPDFJob({inputAsset, params});
*
* const pollingURL = await pdfServices.submit({job});
*
* const pdfServicesResponse = await pdfServices.getJobResult({
* pollingURL,
* resultType: SplitPDFResult
* });
*
* const resultAssets = pdfServicesResponse.result.assets;
* for (const resultAsset of resultAssets) {
* const streamAsset = await pdfServices.getContent({asset: resultAsset});
* }
* ```
*/
class SplitPDFJob extends PDFServicesJob_1.PDFServicesJob {
/**
* Constructs a new `SplitPDFJob` instance.
*
* @param params - The parameters for constructing an instance of `SplitPDFJob`.
* @param params.inputAsset The input asset for the job. Cannot be undefined.
* @param params.params {@link SplitPDFParams} object containing the parameters for splitting the PDF.
* Cannot be undefined.
* @param [params.outputAsset] - {@link Asset} object representing the output asset.
*/
constructor(params) {
super();
ValidationUtil_1.ValidationUtil.validateSplitPDFJobParams(params);
this._inputAsset = params.inputAsset;
this._splitPDFParams = params.params;
this._outputAsset = params.outputAsset;
}
/**
* @hidden
*/
async process(executionContext, notifierConfigList) {
this.validate(executionContext);
const splitPDFRequest = this.generatePDFServicesAPIRequest(notifierConfigList), xRequestId = (0, uuid_1.v4)(), response = await PDFServicesHelper_1.PDFServicesHelper.submitJob(executionContext, splitPDFRequest, xRequestId, OperationHeaderInfoEndpointMap_1.OperationHeaderInfoEndpointMap.SPLIT_PDF);
return response.headers[DefaultRequestHeaders_1.DefaultRequestHeaders.LOCATION_HEADER_NAME];
}
generatePDFServicesAPIRequest(notifierConfigList) {
let splitPDFRequest;
if (this._inputAsset instanceof CloudAsset_1.CloudAsset) {
splitPDFRequest = new SplitPDFInternalAssetRequest_1.SplitPDFInternalAssetRequest(this._inputAsset.assetId, this._splitPDFParams, notifierConfigList);
}
else {
splitPDFRequest = new SplitPDFExternalAssetRequest_1.SplitPDFExternalAssetRequest(this._inputAsset, this._splitPDFParams, this._outputAsset, notifierConfigList);
}
return splitPDFRequest;
}
}
exports.SplitPDFJob = SplitPDFJob;
//# sourceMappingURL=SplitPDFJob.js.map