Registry / serialization / json-api-normalizer

json-api-normalizer

library1.0.4jsnpmunverified

The `json-api-normalizer` package provides a utility to transform JSON:API compliant response data into a normalized, Redux-friendly format. Unlike general-purpose normalization libraries such as Normalizr, this package directly interprets the JSON:API specification, eliminating the need for manual schema definitions. It converts collections of resources into key-value maps, where keys are resource IDs, making it highly suitable for efficient state management within Redux applications. The current stable version is 1.0.4. Development appears to be largely inactive since 2017, with the last commit on GitHub approximately five years ago, suggesting a potentially abandoned status. Its primary differentiator is its direct, schema-less adherence to the JSON:API specification, providing a simpler setup for compliant APIs.

serialization data

npm install json-api-normalizer

github ↗package ↗

INSTALL

IMPORT

SIG · JSON-API-NORMALIZE

json-api-normalizer

serializationjavascriptv1.0.4

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

normalize

✓ import normalize from 'json-api-normalizer';

✗ import { normalize } from 'json-api-normalizer';

The primary normalization function is a default export. Attempting to destructure it will result in 'undefined'.

normalize (CommonJS)

✓ const normalize = require('json-api-normalizer');

✗ import normalize from 'json-api-normalizer';

For CommonJS environments, use `require`. The package provides both ESM and CJS entry points for compatibility.

This example demonstrates how to normalize a JSON:API response, including related 'included' data, and how to use the `endpoint` option to store request-specific metadata.

import normalize from 'json-api-normalizer'; const json = { data: [{ "type": "post-block", "relationships": { "question": { "data": { "type": "question", "id": "295" } } }, "id": "2620", "attributes": { "text": "I am great!", "id": 2620 } }], included: [{ "type": "question", "id": "295", "attributes": { "text": "How are you?", id: 295 } }] }; console.log(normalize(json)); /* Expected Output: { question: { "295": { id: 295, type: "question" attributes: { text: "How are you?" } } }, postBlock: { "2620": { id: 2620, type: "postBlock", attributes: { text: "I am great!" }, relationships: { question: { type: "question", id: "295" } } } } } */ const normalizedWithEndpoint = normalize(json, { endpoint: '/post-block/2620' }); console.log(normalizedWithEndpoint.meta);

Debug

Known issues

breakingThe `json-api-normalizer` package is effectively abandoned, with its last commit on GitHub occurring approximately five years ago. This means it has not been updated since 2017 and may have significant compatibility issues with modern JavaScript environments, newer Redux versions, or evolving JSON:API specifications.

fix

Consider migrating to a more actively maintained JSON:API client or normalization library, or fork the project for custom maintenance. Thorough testing is required if used in a modern stack.

affects: >=1.0.0

gotchaThe library processes JSON:API responses according to the specification prevalent around 2017. Later revisions or extensions to the JSON:API spec (e.g., more complex relationship types, meta object placement) might not be fully supported or normalized as expected.

fix

Manually verify normalization behavior against your specific JSON:API server's response format, especially if your API uses newer JSON:API features or custom extensions.

affects: >=1.0.0

gotchaBy default, query options in the endpoint URL are ignored when storing metadata unless the 'filterEndpoint' option is explicitly set to `false`. This can lead to overwriting cached data if different queries to the same base endpoint return distinct datasets.

fix

Set `filterEndpoint: false` in the options object if you need distinct metadata entries for different query parameters (e.g., `normalize(json, { endpoint: '/posts?page=1', filterEndpoint: false })`).

affects: >=1.0.0

Errors

Common errors & fixes

TypeError: json_api_normalizer__WEBPACK_IMPORTED_MODULE_0__.normalize is not a function

Attempting to import `normalize` as a named export (`import { normalize } from '...'`) when it is a default export.

fix

Change the import statement to `import normalize from 'json-api-normalizer';`

TypeError: Cannot read properties of undefined (reading 'meta') when trying to access normalized output with meta data

The 'endpoint' option was not provided to the `normalize` function, which is necessary for the library to generate the `meta` object in the output.

fix

Ensure the `endpoint` option is passed to the `normalize` function with a string value representing the request endpoint, e.g., `normalize(json, { endpoint: '/api/resource' })`.

Upgrade

Version history

1.0.4latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

10 hits · last 30 days

node

Resources

githubhttps://github.com/yury-dymov/json-api-normalizer ↗

packagehttps://www.npmjs.com/package/json-api-normalizer ↗