npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@ridi/pdf-parser

v0.7.4-alpha.1

Published

Common PDF data parser for Ridibooks services

Downloads

11

Readme

@ridi/pdf-parser

Common PDF data parser for Ridibooks services

NPM version Check codecov NPM total downloads

Features

  • [x] Structure parsing
  • [ ] Read files
    • [ ] Read cover page
  • [x] Encrypt and decrypt function when parsing or reading
  • [ ] Debug mode
  • [ ] Environment
    • [x] Node
    • [ ] CLI
    • [ ] Browser
  • [ ] Online demo

Install

npm install @ridi/pdf-parser

Usage

Basic:

import { PdfParser } from '@ridi/pdf-parser';
// or const { PdfParser } = require('@ridi/pdf-parser');

const parser = new PdfParser('./foo/bar.pdf');
parser.parse().then((book) => {
  ...
});
parser.read().then((pdfFileBuffer) => {
  ...
});

with AesCryptor:

import { CryptoProvider, AesCryptor } from '@ridi/pdf-parser';
// or const { CryptoProvider, AesCryptor } = require('@ridi/pdf-parser');

const { Purpose } = CryptoProvider;
const { Mode, Padding } = AesCryptor;

class ContentCryptoProvider extends CryptoProvider {
  constructor(key) {
    super();
    this.cryptor = new AesCryptor(Mode.ECB, { key });
  }

  getCryptor(filePath, purpose) {
    return this.cryptor;
  }

  // If use as follows:
  // const provider = new ContentCryptoProvider(...);
  // const parser = new PdfParser('encrypted.pdf', provider);
  // const book = await parser.parse();
  // const cover = await parser.readItem(book.cover);
  //
  // It will be called as follows:
  // 1. run(data, 'encrypted.pdf', Purpose.READ_IN_DIR)
  // 2. run(data, 'encrypted.pdf', Purpose.READ_IN_DIR)
  //
  run(data, filePath, purpose) {
    const cryptor = this.getCryptor(filePath, purpose);
    if (purpose === Purpose.READ_IN_DIR) {
      return cryptor.decrypt(data, { padding: Padding.AUTO });
    }
    return data;
  }
}

const cryptoProvider = new ContentCryptoProvider(key);
const parser = new PdfParser('./foo/bar.pdf', cryptoProvider);

Log level setting:

import { LogLevel, ... } from '@ridi/pdf-parser';
const parser = new PdfParser(/* path */, /* cryptoProvider */, /* logLevel */)
// or const parser = new PdfParser(/* path */, /* logLevel */)
parser.logger.logLevel = LogLevel.VERBOSE; // SILENT, ERROR, WARN(default), INFO, DEBUG, VERBOSE

API

parse(parseOptions)

Returns Promise<PdfBook> with:

Or throw exception.

parseOptions: ?object


read()

Returns PDF file as Buffer.


onProgress = callback(step, totalStep, action)

Tells the progress of parser through callback.

const { Action } = PdfParser; // PARSE, READ_ITEMS
parser.onProgress = (step, totalStep, action) => {
  console.log(`[${action}] ${step} / ${totalStep}`);
}

Model

PdfBook

  • version: Version
  • title: string
  • author: string
  • subject: string
  • keywords: string
  • creator: string
  • producer: string
  • creationDate: ?string
  • modificationDate: ?string
  • outlineItems: OutlineItem[]
  • isLinearized: boolean
  • isAcroFormPresent: boolean
  • isXFAPresent: boolean
  • isCollectionPresent: boolean
  • userInfo: object
  • pageCount: number
  • permissions: Permissions
  • toRaw(): object

Version

  • major: number
  • minor: number
  • patch: number
  • toString(): string

OutlineItem

  • dest: ?string|*[]
  • url: ?string
  • title: string
  • color: Color
  • bold: boolean
  • italic: boolean
  • depth: number (Default: 0)
  • children: OutlineItem[]
  • page: ?number
  • toRaw(): object

Color

  • red: number
  • green: number
  • blue: number
  • intValue: number (ex: 7237488)
  • hexString: string (ex: '#6e6f70')
  • rgbString: string (ex: 'rgb(110, 111, 112)')
  • toRaw(): object

Permissions

  • allowPrinting: boolean
  • allowContentsModifying: boolean
  • allowCopying: boolean
  • allowAnnotationsModifying: boolean
  • allowInteractiveFormsModifying: boolean
  • allowCopyingForAccessibility: boolean
  • allowAssembling: boolean
  • allowHighQualityPrinting: boolean
  • toRaw(): ?number[]

Parse Options


fakeWorker: boolean

Use fake worker when used in a browser environment such as Electron Renderer Proccess.

Default: false

License

Apache-2.0