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

@votingworks/ballot-renderer

v1.0.1

Published

Renders ballots to PDF.

Downloads

1

Readme

Ballot Renderer

Renders ballots to PDF.

Example

import { getContests, vote, CompletedBallot } from '@votingworks/ballot-encoder'
import render from '@votingworks/ballot-renderer'

// build the ballot
function makeBallot(): CompletedBallot {
  const ballotStyle = election.ballotStyles[0]
  const precinct = election.precincts[0]
  const ballotId = 'abcde'
  const contests = getContests({ ballotStyle, election })
  const votes = vote(contests, {
    'judicial-robert-demergue': 'yes',
    'judicial-elmer-hull': 'yes',
    'question-a': 'yes',
    'question-b': 'no',
    'question-c': 'yes',
    'proposition-1': 'yes',
    'measure-101': 'no',
    '102': 'yes',
  })

  return {
    election,
    ballotId,
    ballotStyle,
    precinct,
    votes,
  }
}

// render to file (NodeJS)
import * as fs from 'fs'
import { promisify } from 'util'

const writeFile = promisify(fs.writeFile)

async function renderToFile(
  path: string,
  ballot: CompletedBallot
): Promise<void> {
  await fs.writeFile('output.pdf', await render(ballot))
}

// render inline in the browser (React)
import * as ReactDOM from 'react-dom'
import * as b64 from 'base64-js'

async function main() {
  ReactDOM.render(
    <iframe
      src={`data:application/pdf;base64,${b64.fromByteArray(
        await render(ballot)
      )}`}
      title="ballot"
      style={{ height: '100vh', width: '100%' }}
    />,
    document.body
  )
}

Usage

Rendering a ballot is as easy as passing a CompletedBallot to render, returning a Buffer:

import { render } from '@votingworks/ballot-renderer'

async function renderAndDoSomethingWithPDF(
  ballot: CompletedBallot
): Promise<void> {
  const pdfContents = render(ballot)

  // …
}

By default this will use the latest encoding from @votingworks/ballot-encoder, but if you wish you can specify the version to use:

import { EncoderVersion } from '@votingworks/ballot-encoder'
import { render } from '@votingworks/ballot-renderer'

async function renderAndDoSomethingWithPDF(
  ballot: CompletedBallot
): Promise<void> {
  const pdfContents = render(ballot, { encoderVersion: EncoderVersion.v0 })

  // …
}

Separate ballot document creation from PDF rendering

Sometimes it's useful to be able to separate the ballot document creation step from the PDF rendering step. For example, you may wish to generate the ballot document in a client and send it to a server for rendering. Here's how you can achieve that:

// client (e.g. a browser)
import ballotToDocument from '@votingworks/ballot-renderer/renderers/ballotToDocument'

async function renderPDF(): Promise<Blob> {
  const response = await fetch('http://localhost:8080/my/render/endpoint', {
    method: 'POST',
    body: JSON.stringify(ballotToDocument(completedBallot)),
  })

  return response.blob()
}

// server (e.g. nodejs + express)
import documentToPdf from '@votingworks/ballot-renderer/renderers/documentToPdf'
import express from 'express'

const app = express()

app.post('/my/render/endpoint', async (req, res) => {
  const { body } = req
  const json = new TextDecoder().decode(body)
  const document = JSON.parse(json)
  const pdf = await documentToPdf(document)

  res.end(pdf)
})

app.listen(8080)

See the renderers folder for all the partial renderings you can do.