json-data-mapper
TypeScript icon, indicating that this package has built-in type declarations

1.0.3 • Public • Published

Json-data-mapper

Introduction

Single page applications will have JSON responses from the middleware API's. Most of the time we definitely require an adapter layer to transform data from API as needed by the UI layer. This module provides a single adaptive layer which will transform the JSON received from API to the UI required format. This is a native typescript module.

Get Started

npm i json-data-mapper --save

How To Use

Specify the JSON Schema to which the data has to be transformed in a Json file, in the below format

sample.json


{
      isList:true,
      data:'',
      format: {
          "label": {
              sourceField:"name"
          },
          "data": {
              sourceField :"template"
          },
          "transform":{
              sourceField: "(name,template)=>{return name+'%%'+template;}",
              type:"FUNCTION"
          } 
      }
 }
 

Build Schema

  • The isList property tells whether the output Json should be a list.
  • You can set data property to any object from the API response and the library will process the data only in that object specified, omitting all other objects in the API response.
  • The format object contains the actual format in which the data mapping has to be done.
    • Each key represents a property in the output Json.
    • sourceField - should be the key of the value to be processed from the API data. This can also accept a transform fn in which case the parameters to the function should be the keys of the value to be processed from the API data. You can pass a complete function as a string as shown in the sample.
    • type - if the sourceField is provided with a transform function then should be set to FUNCTION. if its a property in output json then should be set to FIELD.

Implementation

In your application, Import the json file and add below code.

import { JsonMapper } from 'json-data-mapper';

const transformedData = JsonMapper.formatToSchema(schema, data);

In the code above schema is the Json schema imported from the json file, and data is your actual API response which has to be transformed.

Using this library you can maintain all your transforms in a single JSON file and let the library do the data mapping for all the API's. if the API layer changes the JSON schema alone has to be tweaked as per needs avoiding any code change in the UI layer.

Example

This is a sample schema

{
   isList:true,    
   format: {
     "label": {
         sourceField:"name"
     },
     "data": {
         sourceField :"template"
     },
     "transform":{
         sourceField: "(name,template)=>{return name+' has '+template;}",
         type:"FUNCTION"
     } 
   }
 }

Input Data

 {
   name: "user",
   template: "test Template"
 }

Transformed Data

 { 
   label: 'user',
   data: 'test Template',
   transform: 'user has test Template' 
 }

Contributor

@gkrthk

Package Sidebar

Install

npm i json-data-mapper

Weekly Downloads

79

Version

1.0.3

License

MIT

Unpacked Size

10.4 kB

Total Files

7

Last publish

Collaborators

  • gkrthk