Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
@algolia/json-stream-analyzer
Advanced tools
Readme
A library to analyze JSON streams and find structural issues in the stream's schema
This tool is currently designed for internal use only. There is no guarantee on maintenance, or stability, of the API of the tool. It may change at any point, without warning, and without following proper semver.
import { SimpleTagModel } from '@algolia/json-stream-analyzer/models';
// this will build a model that can keep track of the schema of a stream
// and keep one tag for each diverging element of the schema
const model = new SimpleTagModel({
tag: (record) => record.objectID
});
const records = [
{
objectID: 1,
title: 'How to build a performant library?',
prices: {
hardcover: 52,
ebook: 10,
},
},
{
objectID: 3,
title: 'Mastering the art of example in 12 steps',
description:
'The description and prices.hardcover fields are missing in some records and prices.ebook has multiple types',
prices: {
ebook: '10$',
},
},
];
// feed the records to the model
records.forEach(model.addToModel);
// get the schema of the model
console.log(JSON.stringify(model.schema, null, 2));
/*
{
"counter": 2,
"tag": 1,
"type": "Object",
"schema": {
"objectID": {
"counter": 2,
"tag": 1,
"type": "Number"
},
"title": {
"counter": 2,
"tag": 1,
"type": "String"
},
"description": {
"counter": 2,
"type": "Union",
"types": {
"Missing": {
"counter": 1,
"tag": 1,
"type": "Missing"
},
"String": {
"counter": 1,
"tag": 3,
"type": "String"
}
}
},
"prices": {
"counter": 2,
"tag": 1,
"type": "Object",
"schema": {
"ebook": {
"counter": 2,
"type": "Union",
"types": {
"Number": {
"counter": 1,
"tag": 1,
"type": "Number"
},
"String": {
"counter": 1,
"tag": 3,
"type": "String"
}
}
},
"hardcover": {
"counter": 2,
"type": "Union",
"types": {
"Number": {
"counter": 1,
"tag": 1,
"type": "Number"
},
"Missing": {
"counter": 1,
"tag": 3,
"type": "Missing"
}
}
}
}
}
}
}
*/
// immediately find issues within the schema
const diagnostics = model.diagnose();
/*
[
{
id: 'missing',
title: 'Missing Data',
type: 'Union',
path: [ 'description' ],
affected: 1,
tag: 1
},
{
id: 'healthy',
title: 'Healthy Records',
type: 'Union',
path: [ 'description' ],
affected: 1,
tag: 3
},
{
id: 'inconsistentType',
title: 'Inconsistent Type (String instead of Number)',
type: 'Union',
path: [ 'prices', 'ebook' ],
affected: 1,
tag: 3
},
{
id: 'healthy',
title: 'Healthy Records',
type: 'Union',
path: [ 'prices', 'ebook' ],
affected: 1,
tag: 1
},
{
id: 'missing',
title: 'Missing Data',
type: 'Union',
path: [ 'prices', 'hardcover' ],
affected: 1,
tag: 3
},
{
id: 'healthy',
title: 'Healthy Records',
type: 'Union',
path: [ 'prices', 'hardcover' ],
affected: 1,
tag: 1
}
]
*/
// find issues within record based on a schema
model.diagnoseRecord({
objectID: 1,
title: 'How to build a performant library?',
prices: {
hardcover: 52,
ebook: 10,
},
});
/*
[
{
id: 'missing',
title: 'Missing Data',
type: 'Union',
path: [ 'description' ],
affected: 2,
tag: 1
}
]
*/
FAQs
A library to analyze JSON streams and find structural issues in the stream's schema
The npm package @algolia/json-stream-analyzer receives a total of 31 weekly downloads. As such, @algolia/json-stream-analyzer popularity was classified as not popular.
We found that @algolia/json-stream-analyzer demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 66 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.