Skip to content

Utilities to work with PSPDFKit's server-side rendering

License

Notifications You must be signed in to change notification settings

shelfio/pspdfkit-ssr

Folders and files

NameName
Last commit message
Last commit date
Jul 15, 2022
Apr 4, 2022
Nov 13, 2023
Jun 13, 2019
Jun 13, 2019
Jun 17, 2021
Jun 13, 2019
Apr 4, 2022
Jun 13, 2019
Jun 13, 2019
Jun 13, 2019
Jun 13, 2019
Mar 2, 2025
Dec 15, 2021
Jun 30, 2023
Jun 17, 2021
Jun 17, 2021

Repository files navigation

pspdfkit-ssr CircleCI npm (scoped)

Install

$ yarn add @shelf/pspdfkit-ssr

Usage

const {createReadStream} = require('fs');
const {uploadPDF, getJWTForDocumentPreview} = require('@shelf/pspdfkit-ssr');

const documentId = await uploadPDF({
  documentId: 'some-custom-document-id',
  fileStream: createReadStream('./file.pdf'),
  fileSize: 1024,
});

const jwt = getJWTForDocumentPreview(documentId);

Note: this library relies upon following environment variables:

  • PSPDFKIT_SERVER_URL
  • PSPDFKIT_SERVER_AUTH_TOKEN
  • PSPDFKIT_SERVER_JWT_KEY
  • PSPDFKIT_SERVER_JWT_PASSPHRASE

Note: this library tries to be idempotent. Unlike PSPDFKit server, it catches errors when document with provided ID was already uploaded.

See Client Authentication section of PSPDFKit documentation for details.

Publish

  • Run sudo npx np, follow interactive UI. Please select appropriate version bump according to semver.

  • After redirect to the prepared release of the early published package just press button Publish release

License

MIT © Shelf