data-restructor-js

Transforms parsed JSON objects into a uniform data structure

APACHE-2.0 License

Downloads
101
Stars
2
Committers
4
View Code on GitHub Visit Website
Ecosystems: JSON, JavaScript
data-restructor-js - v3.4.2 Regenerate CHANGELOG in continuous integration pipeline Latest Release

Published by JohT about 1 year ago

Features

Dependency Updates

Full Changelog: https://github.com/JohT/data-restructor-js/compare/v3.4.1...v3.4.2

data-restructor-js - v3.4.1 Auto Changelog

Published by JohT over 1 year ago

Features

Dependency Updates

Full Changelog: https://github.com/JohT/data-restructor-js/compare/v3.4.0...v3.4.1

data-restructor-js - v3.4.0 Update to Node.js v18

Published by JohT almost 2 years ago

Automation

Other Changes

Version Updates

Full Changelog: https://github.com/JohT/data-restructor-js/compare/v3.3.4...v3.4.0

data-restructor-js - Remove duplicate groups within recursion

Published by JohT over 3 years ago

Fixes:

  • #12 Zero recursion duplication should be possible
data-restructor-js - IE support fix

Published by JohT over 3 years ago

Fixes:

  • Use classic property definitions idiom instead of ES6 PropertyShorthand for internet explorer (IE) support.
data-restructor-js - Encourage Open Source Contributing

Published by JohT over 3 years ago

Features:

  • README.md contains a description on how to build the module.
  • CODE_OF_CONDUCT.md sets the standard for an open, welcoming,
    diverse, inclusive, and healthy community.
  • CONTRIBUTING.md provides information for those who want to contribute
  • issue templates support submitting issues for bugs and new features
  • PARCEL v2 migration
  • update dependency versions
data-restructor-js - Output folder fixed

Published by JohT over 3 years ago

Fixes:

  • Minified output destination fixed. Minified files are now correctly written into the "dist" folder (instead of "dev").
data-restructor-js - Support direct use of modules in "dist" and "devdist" folder

Published by JohT over 3 years ago

Features:

  • #7 Add merged global JavaScript files in "dist" and "devdist" to use them without module system
  • security vulnerability CVE-2021-23358 https://github.com/advisories/GHSA-cf4h-3jhx-xvhq addressed
  • REAMDE.MD now contains a lists of credits
  • COMMANDS.MD now contains a separate list for commands, that are used on a regular basis
data-restructor-js - Configurable recursion depth above which duplications will be removed

Published by JohT over 3 years ago

Features:

  • #5 Configurable recursion depth above which duplications will be removed.
data-restructor-js - Configurable recursion depth for sub groups

Published by JohT over 3 years ago

Features:

  • Configurable maximum recursion depth for field groups inside groups inside groups...
  • Improved JSDoc structure and contents

Fixes:

  • #3 Group hierarchy limited to 1 since v3.0.0

Deprecated:

  • datarestructor.Restructor.processJsonUsingDescriptions(jsonData, descriptions) is deprecated.
    Please use new datarestructor.Transform(descriptions).processJson(jsonData) instead.
data-restructor-js - DescribedDataField

Published by JohT over 3 years ago

Features:

  • Pure, non cyclic data result that can be converted to json without using additional functions

Breaking Changes:

  • DescribedDataField replaces DescribedEntry as an element for the restructured output
  • DescribedEntry remains only for internal use
  • DescribedEntry function "resolveTemplate" is removed. "templateResolver.js" can be used instead.
  • DescribedEntry function "publicFieldsJson" is removed. JSON.stringify(describedEntry.describedField) can be used instead.
data-restructor-js - Continuous Integration

Published by JohT over 3 years ago

  • Continuous Integration using GitHub Actions
  • Build using nodes package manager (npm)
  • Bundle (minification,...) using Parcel Bundler
  • Automated already existing unit tests using Jasmine
  • Unit-Test coverage measurement using nyc
  • Documentation Generation using JSDoc
  • Static code analysis using ESLint
  • Updated documentation
data-restructor-js - Resolving template with described fields

Published by JohT almost 4 years ago

Since v1.2.0 templates containing variables in double curly brackets can be resolved by the function resolveTemplate(templateString). Now, it is not only possible to resolve the contained meta data, but also the described fields directly. Based on the JSON below, the resolver would now provide these results:

  • "{{customerNumber}}"-> "123"
  • "{{details.name}}"-> "Smith"
  • "{{details.age}}"-> "31"

Previously (since v1.2.0), these results could only be obtained with (remains unchanged):

  • "{{value}}"-> `"123"
  • "{{details[0].value}}"-> `"Smith"
  • "{{details[1].value}}"-> `"31"
{
  "category": "customer",
  "type": "summary",
  "displayName": "CustomerNumber",
  "fieldName": "customerNumber", 
  "value": "123",
  "details": [
  {
    "category": "customer;",
    "type": "detail",
    "displayName": "Name",
    "fieldName": "name",
    "value": "Smith"
  },
  {
    "category": "customer",
    "type": "detail",
    "displayName": "Age",
    "fieldName": "age",
    "value": "31"
  }
  ]
}
data-restructor-js - new optional fields "abbreviation" and "image"

Published by JohT almost 4 years ago

This minor release contains the following impprovements:

  • With the two new optional fields abbreviation and image, that can be specified for each PropertyStructureDescription, it is easier to separate display related fields from e.g. the category. These fields are transferred directly into the resulting DescribedEntry and do not affect other behavior (grouping, filtering...) in any kind.
  • If the variable {{fieldName}} is missing in the property pattern in "template mode", the right most part of the property name is used as field name. This corresponds to the behavior of the "equal mode". Previously this led to an error that forced the use of the "equal mode" in that case.
  • Some minor refactoring
data-restructor-js - Added "publicFieldsJson" to "DescribedEntry"

Published by JohT almost 4 years ago

It is now possible to convert the public fields of an DescribedEntry to JSON using its function publicFieldsJson.
This includes all contained groups, that may contain DescribedEntrys themselves.

Prior to this release, the following error occurred when calling JSON.stringify(describedEntry):
TypeError: Converting circular structure to JSON

Note:
The property isMatchingIndex of the DescribedEntry had been renamed to _isMatchingIndex since it is an internal property
and should not be used outside. Since this is a "breaking change" (in theory), it lead to a new major version.

This example shows how the returned JSON looks like using parameter "space" = 2 (pretty print with 2 spaces indentation)
when the DescribedEntry contains the group options:

{
  "category": "account",
  "type": "filter",
  "displayName": "Currency",
  "fieldName": "currency",
  "value": "eur",
  "options": [
    {
      "category": "account;",
      "type": "filter",
      "displayName": "Currency",
      "fieldName": "currency",
      "value": "EUR"
    },
    {
      "category": "account",
      "type": "filter",
      "displayName": "Currency",
      "fieldName": "currency",
      "value": "USD"
    }
  ]
}
data-restructor-js - Resolving template containing properties of the described entry as variables

Published by JohT almost 4 years ago

It is now possible to resolve a string containing variables in double curly brackets of an DecribedEntryusing the function resolveTemplate(templateString).

Variables that can be used are e.g. :

  • "{{fieldName}}"
  • "{{displayName}}"
  • "{{value}}"
  • "{{index}}"
  • "{{index[1]}}"

Example:

var rawEntry = { name: "responses[0].hits.hits[3]._source.name", value: "Smith" };
var description = new datarestructor.PropertyStructureDescriptionBuilder().type("testtype").category("testcategory").build();
var describedEntry = new datarestructor.DescribedEntryCreator(rawEntry, description);

var resolved = describedEntry.resolveTemplate("{{displayName}}: {{value}}");
// resolved is: "Name: Smith"
data-restructor-js - Joining and renaming groups

Published by JohT almost 4 years ago

  • Group destination name and joining (JohT@534c368bcb835c110e1255508ed44c790972955c)
    • Groups can now be renamed, when they get moved to another destination.
    • If more than one source group (array) is moved into a single destination, they get joined.
      Previously, only the last one remained, which made it impossible to structure data within one single (e.g. main) entry.
  • Debug mode introduced (JohT@72232e7f23ced9655c1d2693a3a5b3163c312221)
  • Minor refactorings (JohT@14094fe247c1c1551ff518a1378a26b0cfc074c9)
data-restructor-js - Initial Release

Published by JohT about 4 years ago

Features of this first release:

  • Adapter that takes e.g. parsed JSON and transforms it into a standardized structure
  • Multiple transformation steps including flattening, removing duplicates, grouping, ...
  • Takes descriptions that reflect the incoming structure and define the standardized output
  • Reusable and flexible
  • Supports most browser including ie5
Package Rankings
Top 12.18% on Npmjs.org
Badges
Extracted from project README
License
Related Projects
jfather

Library to merge, extend and override JSON objects.

10 Feb 2024 1
blas-ext-base-gapx

Add a constant to each element in a strided array.

13 Jun 2021 2
zeed

🌱 Simple foundation library / framework written in Typescript. No dependencies. Tree shakable.

01 Jul 2021 34
utils-common-keys-in

Return the common own and inherited property names of two or more objects.

23 Sep 2021 2
agile

Like Underscore, but with zero callbacks and really more fun, v0.0.2

22 Oct 2014 69
cleave.js

Format input text content when you are typing...

18 May 2016 17,957
jsen

JSON-Schema validator built for speed

05 Feb 2015 156
array-base-flatten5d

Flatten a five-dimensional nested array.

21 Jul 2023 1
rollup-plugin-cleanup

Rollup plugin to remove comments, trim trailing spaces, compact empty lines, and normalize line e...

05 Sep 2016 99
string-base-remove-last

Remove the last UTF-16 code unit of a string.

21 Sep 2023 1
agjCalendar

agjCalendar is a plugin for the jQuery Javascript library to deal with calendars, dates and date ...

29 Jan 2013 3
licensify

Browserify plugin to prepend license header to your bundle

02 Dec 2014 166
utils-inherit

Implement prototypical inheritance by replacing the prototype of one constructor with the prototy...

02 Jun 2021 2
array-one-to

Generate a linearly spaced numeric array whose elements increment by 1 starting from one.

18 Jan 2024 1
deeply

A toolkit for deep structure manipulations, provides deep merge/clone functionality out of the bo...

03 Sep 2013 1