# json-map-transform > Node library that transforms a json object or an array of json objects based on tranformation template Latest version **1.2.6** (published 2019-07-29) · MIT license · 0 weekly downloads ## Install ```sh npm install json-map-transform pnpm add json-map-transform yarn add json-map-transform bun add json-map-transform ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.2.6 | | Published | 2019-07-29 | | First published | 2018-11-29 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 0 | | Unpacked size | 90 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 14 | | Author | Eduardo A. David | | Maintainers | edudavid | | Keywords | json, json transform, json convert, transform json array | ## Links - npm: https://www.npmjs.com/package/json-map-transform - Repository: https://github.com/edudavid/json-map-transform - Homepage: https://github.com/edudavid/json-map-transform#readme - Issues: https://github.com/edudavid/json-map-transform/issues - npm.io page: https://npm.io/package/json-map-transform ## Alternatives - [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads - [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads - [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads - [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads - [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads ## Recent versions - 1.2.6 (latest) — 2019-07-29 - 1.2.5 — 2019-03-29 - 1.2.4 — 2019-01-07 - 1.2.3 — 2018-12-26 - 1.2.2 — 2018-12-26 - 1.2.1 — 2018-12-20 - 1.2.0 — 2018-12-20 - 1.1.2 — 2018-12-10 - 1.1.1 — 2018-12-05 - 1.1.0 — 2018-12-05 - 1.0.16 — 2018-12-03 - 1.0.15 — 2018-12-01 - 1.0.14 — 2018-12-01 - 1.0.12 — 2018-12-01 - 1.0.11 — 2018-12-01 - … 11 more at https://npm.io/package/json-map-transform/versions ## README # json-map-transform [![Build Status](https://travis-ci.org/edudavid/json-map-transform.svg?branch=master)](https://travis-ci.org/edudavid/json-map-transform) [![Coverage Status](https://coveralls.io/repos/github/edudavid/json-map-transform/badge.svg)](https://coveralls.io/github/edudavid/json-map-transform) A lighweight Node library that transforms a json object or an array of json objects based on tranformation template. ## Installation Using npm: ``` npm i --save json-map-transform ``` ## Usage [Template](#template) [Single object transformation](#single-object-transformation) [Array transformation](#array-transformation) --- ### Template **Key:** Each key property in the template object describes the path to the property in the output object. This is where the value in **path** of the input object will be mapped to. **Path:** Is the path to the property in the input object that will be mapped to the template key. It can also be an array of possible paths in case the objects doesn't follow an exact pattern. **Transform:** Is a callback that can be used to transform the current property. It receives two parameters: (property, originalObject). **Default:** In case a path does not exists in the input object or the value returned by transform is undefined, the default value will be used. **OmitValues:** Sometimes it is necessary to ignore values on the transformation (ex: undefined, empty string or other values depending on a business rule). With the omitValues, it is possible to define an array of values that should be ignored on the transformation. The output object will not have the associated key. Template example: ```javascript const template = { title: { path: 'name', transform: (val) => val.toUpperCase() }, label: { path: ['category', 'categories'], omitValues: ['', undefined, 'ERROR'] }, vendor: { path: 'meta.vendor', default: 'No vendor' }, 'meta.photos': { path: 'photos', transform: (val) => val.map(photo => photo.photoUrl) }, 'meta.id': { path: 'code' } } ``` This template will work like this: | from | to | transform | | :--------------------- |:-------------- | :-------------- | | name | title | toUpperCase() | | [category, categories] | label | | | meta.vendor | vendor | | | photos | meta.photos | photo.photoUrl | | code | meta.code | | ### Single object transformation ```javascript const transform = require('json-map-transform'); //The json objects to be transformed const product1 = { name: 'Hello world', code: 'BOOK01', category: 'books', price: '200', photos: [ { title: 'photo1', photoUrl: 'http://photo1.jpg', isCover: true }, { title: 'photo2', photoUrl: 'http://photo2.jpg' } ], meta: { vendor: 'Author name' } }; const product2 = { name: 'My Digital Product', code: 'DIGITAL01', category: 'digital', price: '500', photos: [ { title: 'photo3', photoUrl: 'http://photo3.jpg', isCover: true }, { title: 'photo4', photoUrl: 'http://photo4.jpg' } ], meta: { vendor: 'Global Digital' } }; convertedJson = transform(product1, template); //Output object { "title": "HELLO WORLD", "label": "books", "vendor": "Author name", "meta": { "photos": [ "http://photo1.jpg", "http://photo2.jpg" ], "id": "BOOK01" } } ``` You ca also use an optional callback to be executed after the transformation ```javascript const afterTransform = (element) => Object.assign({}, element, { categoryCode: element.label == 'books' ? 101 : 102 }); transform(product1, template, afterTransform); // Output json { "title": "HELLO WORLD", "label": "books", "vendor": "Author name", "meta": { "photos": [ "http://photo1.jpg", "http://photo2.jpg" ], "id": "BOOK01" }, "categoryCode": 101 } ``` ### Array transformation ```javascript // The afterTransform callback is also optional transform([product1, product2], template, afterTransform); [ { "title": "HELLO WORLD", "label": "books", "vendor": "Author name", "meta": { "photos": [ "http://photo1.jpg", "http://photo2.jpg" ], "id": "BOOK01" }, "categoryCode": 101 }, { "title": "MY DIGITAL PRODUCT", "label": "digital", "vendor": "Global Digital", "meta": { "photos": [ "http://photo3.jpg", "http://photo4.jpg" ], "id": "DIGITAL01" }, "categoryCode": 102 } ] ``` The afterTransform callback is called after each element tranformation. --- _Source: https://npm.io/package/json-map-transform · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._