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

@govtechsg/workpass-schema

v1.0.9

Published

This library supplies the schemas used for SGworkpass 2.0, in the form of [json schemas](http://json-schema.org)

Downloads

13

Readme

Workpass Schema v1.1

This library supplies the schemas used for SGworkpass 2.0, in the form of json schemas

Installation

Using npm:

npm install @govtechsg/workpass-schema

Usage

If you are writing a document issuer: you probably want to issue a document or issue multiple documents

If you are writing a document verifier or viewer: you probably want to issue a document or issue multiple documents

If you are writing a document verifier or viewer: you probably want to

Using OpenCerts

const openDocument = require("@govtechsg/workpass-schema")

const exampleDocument = require("example.json") // reading an example document file
openDocument.verify(exampleDocument)

Validate Schema

This library comes with the schemas in the ./schema folder, all of them are loaded as valid schemas upon initialization.

openDocument.validateSchema(exampleDocument)

Verifying Document Signature

Documents are considered untampered-with if they have a valid signature field. Refer to the Open Attestation library for more details on this.

openDocument.verifySignature(exampleDocument)

Issue a Document

A single Document can be issued using the .issueDocument(document) method. Issuing a document in this manner will append a signature field to the document.

The return value of the method will be the signed document.

const issuedCert = openDocument.issueDocument(exampleDocument)

Issue Multiple Documents

Multiple Documents can be issued at once with the .issueDocuments(document[]) method.

The return value of the method will be an array of signed documents.

const exampleDocuments = [cert1, cert2, cert3, ...]
const issuedCerts = openDocument.issueDocuments(exampleDocuments)

Retrieving Document contents

The raw document has salt in the fields to prevent enumeration, we provide a convenience method to retrieve the unsalted contents of the document using the method .documentData(document)

const data = openDocument.documentData(exampleDocument)

Obfuscating Fields in a Document

To obfuscate fields in a cert, the method .obfuscateFields(document, paths[]) is provided. The paths[] parameter is simply the JSON path for the fields to be obfuscated.

The method returns the obfuscated document.

const obfuscatedCert = openDocument.obfuscateFields(exampleDocument, [
    "recipient.fin",
    "recipient.occupation"
]);

Developers

The code is written to ES6 specs with stage-3 presets and is compiled by Babel.

Test

npm run test

Build

npm run build

Related Projects

Open Attestation Document Contract OpenCert Web UI