myinfo-masseuse
v0.0.35
Published
Data massaging for SingPass Mobile to consume MyInfo Data
Readme
MyInfo Data Massager
Usage
Installation
Run npm install myinfo-masseuse --save
Using the api
let Index = require("index");
// Do MyInfo data massaging, returns a formatted myinfo data object
let massagedData = Index.massageData(myInfoData);
// Get Attributes, returns a comma delimited string of attributes
let attributes = Index.getAttributes();
Testing the api
checkout the repo
At repo root directory run npm install
To test run npm test -- testData.json will give u full massage output
To test individual cards run npm test -- testData.json family will give family card output
List of keywords you can use
| keywords | Output | |-----------------|----------| | id | Id Card | | fam | Family Card | | family | Family Card | | polling | Polling Card | | re | Register of Electors Card | | passport | Passport Card | | contact | Contact Card | | income | CPF and Income Card | | cpf | CPF and Income Card | | property | HDB Property Card | | hdb | HDB Property Card | | vehicle | Vehicle Card | | driving license | Driving Licenses Card | | license | Driving Licenses Card | | driving | Driving Licenses Card | | employment | Employment Card | | spf | Warrant and Spent Card | | warrant | Warrant and Spent Card | | spent | Warrant and Spent Card | | moe | Education Card | | education | Education Card | | attr | attributes listing | | attributes | attributes listing |
npm test calls index.js massageData using input data from the json file supplied e.g. test/testJson/testData.json
npm test -- test/testJson/testData.jsonSample Response
Sample response can be found in sample data response.json.
{
"consent" : "Y", // Y or N
"persondata" : [ ], //Array of objects
"imgresource" : [ ] //Array of String image urls
}***** IMPORTANT ***** The above entire response will be encrypted in the jwe.
Ui Data Modeling
Detailed data modeling for UI description can be found here.
