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

sa-node-my-info-sg

v2.0.1

Published

[![npm version](https://badge.fury.io/js/node-my-info-sg.svg)](https://badge.fury.io/js/node-my-info-sg) [![CircleCI](https://circleci.com/gh/stashaway-engineering/node-my-info-sg.svg?style=svg)](https://circleci.com/gh/stashaway-engineering/node-my-info-

Downloads

424

Readme

node-my-info-sg 🇸🇬

npm version CircleCI

Small wrapper around Singapore MyInfo V3 API for node JS. Wraps the scary-scary 😱 security logic into easy to use APIs.

Lightly refactored from the excellent official example 🎉

Usage

  1. Initialise MyInfoClient

    const MyInfoClient = require('node-my-info-sg');
    
    const myInfoClient = new MyInfoClient({
      // MyInfo API base URL (sandbox/test/production)
      // https://www.ndi-api.gov.sg/assets/lib/trusted-data/myinfo/specs/myinfo-kyc-v3.0.1.yaml.html#section/Environments/Available-Environments
      baseUrl: 'https://sandbox.api.myinfo.gov.sg',
         
      // Api auth level (L0 for sandbox; Otherwise L2)
      authLevel: 'L0',
         
      // Public key from MyInfo Consent Platform given to you during onboarding for RSA digital signature
      publicCertPath: './ssl/stg-auth-signing-public.pem',
         
      // Your private key for RSA digital signature
      privateKeyPath: './ssl/stg-demoapp-client-privatekey-2018.pem',
         
      // Your client_id provided to you during onboarding
      clientId: 'STG2-MYINFO-SELF-TEST',
         
      // Your client_secret provided to you during onboarding
      clientSecret: '44d953c796cccebcec9bdc826852857ab412fbe2',
         
      // Redirect URL for your web application
      // https://www.ndi-api.gov.sg/library/trusted-data/myinfo/implementation-technical-requirements (Callback URLs)
      redirectUrl: 'http://localhost:3001/callback',
    });
  2. Generate the OAuth2 url

    const attributes = ['uinfin', 'name', 'mobileno'];
    const { authoriseUrl, state } = myInfoClient.getAuthoriseUrl(purpose, attributes);
    // Then you can pass authoriseUrl to your frontend app
    // (or open authoriseUrl on a WebView on your mobile apps)
    //
    // Note: You might want to store authoriseUrl, attributes, and state to fulfill the transaction log requirements
    // https://www.ndi-api.gov.sg/library/trusted-data/myinfo/implementation-technical-requirements
  3. Get the person object

    // Exchange authorisation code with usable access token
    const { accessToken } = await myInfoClient.getToken(code);
         
    // Get the person object
    // Make sure attributes is the same as the one requested in previous step!
    const { person } = await myInfoClient.getPerson(accessToken, attributes)
         
    // Now you can return the person object to your frontend and pre-fill your form!
    console.log(JSON.stringify(person)); 

Example

In the example directory, run:

yarn install
./start.sh

Unit test

yarn lint
yarn test