remove 'likeAllOf' support and expose helper functions for custom call-backs

Merge pull request #4

Author: CarstenWickner

CHANGELOG.MD

@@ -0,0 +1,60 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [2.1.0] - 2019-05-01
+### Added
+- exporting helper function `getFieldValueArrayFromSchemaGroup()`
+- exporting helper function `getCommonFieldValuesFromSchemaGroup()`
+- exporting helper function `getMaximumFieldValueFromSchemaGroup()`
+- exporting helper function `getMinimumFieldValueFromSchemaGroup()`
+
+### Changed
+- not including `anyOf` or `oneOf` in `<Inspector>` prop `parserConfig` no longer hides the respective schema parts (always including everything)
+
+### Removed
+- "type" property in `<Inspector>` prop `parserConfig.anyOf`/`parserConfig.oneOf` (i.e. always "asAdditionalColumn" behaviour from now on)
+- undocumented export of helper function `getFieldValueFromSchemaGroup()`, one of the four new helper functions should be used instead
+
+## [2.0.1] - 2019-04-24
+### Changed
+- values displayed in (default) Details Form now respect the validation logic behind `allOf` by not simply listing all values for the same field, but rather semantically combining/merging them
+- `"type"` contains only those common/intersecting values if it appears multiple times
+- `"minimum"`/`"minLength"`/`"minItems"` show the maximum value if there are multiple occurrences of the respective field
+- `"maximum"`/`"maxLength"`/`"maxItems"` show the minimum value if there are multiple occurrences of the respective field
+- `"const"`/`"enum"` are used interchangeably for either a single or multiple allowed values
+
+## [2.0.0] - 2019-04-12
+### Added
+- general support for `anyOf` and `oneOf`
+- `anyOf`/`oneOf` may be included or excluded depending on the respective fields with the same name in the `parserConfig` prop
+- can determine the way of inclusion for `anyOf`/`oneOf` via the respective `type` field of value `likeAllOf` or `asAdditionalColumn` in the `parserConfig` prop
+- introduction of explicit (configurable/customisable) column for accessing an array's items and/or other properties
+
+### Changed
+- named export of `<Inspector>` component (instead of default export)
+
+### Removed
+- default export of main component
+
+## [1.2.1] - 2019-03-18
+### Changed
+- configuration of npm bundle; thereby reducing size of release package
+
+## [1.2.0] - 2019-03-09
+### Added
+- allow to mutate the name of a selected item when including it in breadcrumbs (e.g. to sanitise it)
+- allow skipping a breadcrumb (e.g. omitting the root schema selection)
+- include breadcrumbs as array parameter in `onSelect` call-back
+
+## [1.1.0] - 2019-03-08
+### Added
+- offering free-text search input in the top right corner
+- allow defining custom search function (based on a single raw schema – handling of sub-schemas is transparent)
+- allow alternative configuration of field names to search in, e.g. `["title", "description"]`
+
+## [1.0.0] - 2019-03-03

README.md

@@ -27,7 +27,7 @@ Or try it out and [![Edit on CodeSandbox][codesandbox-image]][codesandbox-url]
 npm i react-jsonschema-inspector
 ```
 
-### React Component Props
+### React Component Props of `<Inspector>`
 
 | Prop | Description |
 | --- | --- |
@@ -37,19 +37,17 @@ npm i react-jsonschema-inspector
 | `onSelect` | Function: call-back being invoked after the selection changed. Receives two parameters: (1) the selection - as per the `defaultSelectedItems`, (2) an object containing the "columnData" - the full render information for all visible columns |
 | `buildArrayProperties` | Function: accepting a `JsonSchema` instance representing an array's declared type of items and returning an object listing the available properties to offer with either `JsonSchema` or raw JSON Schemas as values. The default, providing access to the array's items, is: `arrayItemSchema => ({ "[0]": arrayItemSchema })` |
 | `parserConfig` | Object: enabling the inclusion/exclusion of optional parts of a JSON Schema – both for the inclusion of properties and their attributes as well as in the search. |
-| `parserConfig.anyOf` | Object: enabling the inclusion/exclusion of JSON Schema parts wrapped in `anyOf`. |
-| `parserConfig.anyOf.type` | String: can be `"likeAllOf"` or `"asAdditionalColumn"` (the latter being the default if no `parserConfig` is provided). |
-| `parserConfig.anyOf.groupTitle` | String: alternative title to show in option selection column (only relevant if `type: "asAdditionalColumn"`) – defaults to `"any of"` |
-| `parserConfig.anyOf.optionNameForIndex` | Function: providing the name/label to show for a single option (only relevant if `type: "asAdditionalColumn"`) – defaults to ``(optionIndexes) => `Option ${optionIndexes.map(index => index + 1).join("-")}` ``, resulting in e.g. "Option 1", "Option 2-1", "Option 3" |
-| `parserConfig.oneOf` | Object: enabling the inclusion/exclusion of JSON Schema parts wrapped in `oneOf`. |
-| `parserConfig.oneOf.type` | String: can be `"likeAllOf"` or `"asAdditionalColumn"` (the latter being the default if no `parserConfig` is provided). |
-| `parserConfig.oneOf.groupTitle` | String: alternative title to show in option selection column (only relevant if `type: "asAdditionalColumn"`) – defaults to `"one of"` |
-| `parserConfig.oneOf.optionNameForIndex` | Function: providing the name/label to show for a single option (only relevant if `type: "asAdditionalColumn"`) – defaults to ``(optionIndexes) => `Option ${optionIndexes.map(index => index + 1).join("-")}` ``, resulting in e.g. "Option 1", "Option 2-1", "Option 3" |
+| `parserConfig.anyOf` | Object: specifying details of the inclusion of JSON Schema parts wrapped in `anyOf`. |
+| `parserConfig.anyOf.groupTitle` | String: alternative title to show in option selection column – defaults to `"any of"` |
+| `parserConfig.anyOf.optionNameForIndex` | Function: providing the name/label to show for a single option – defaults to ``(optionIndexes) => `Option ${optionIndexes.map(index => index + 1).join("-")}` ``, resulting in e.g. "Option 1", "Option 2-1", "Option 3" |
+| `parserConfig.oneOf` | Object: specifying details of the inclusion of JSON Schema parts wrapped in `oneOf`. |
+| `parserConfig.oneOf.groupTitle` | String: alternative title to show in option selection column – defaults to `"one of"` |
+| `parserConfig.oneOf.optionNameForIndex` | Function: providing the name/label to show for a single option – defaults to ``(optionIndexes) => `Option ${optionIndexes.map(index => index + 1).join("-")}` ``, resulting in e.g. "Option 1", "Option 2-1", "Option 3" |
 | `breadcrumbs` | Object: enabling the definition of options for the breadcrumbs feature in the footer (can be disabled by setting to `null`) |
 | `breadcrumbs.prefix` | String: to be shown in front of the root selection (e.g. "//" or "./") – defaults to `""` |
 | `breadcrumbs.separator` | String: to be shown in front of any non-root selection (e.g. "/") – defaults to `"."` |
 | `breadcrumbs.skipSeparator` | Function: expecting a `JsonSchema` as input and should return an object containing `JsonSchema` or raw JSON Schemas as values – defaults to excluding `"[0]"` |
-| `breadcrumbs.mutateName` | Function: expecting two inputs: (1) the selected item's name, (2) the full information for the respective column and (3) the index of the respective column; a column's breadcrumb can be skipped by returning `null` |
+| `breadcrumbs.mutateName` | Function: expecting the following inputs: (1) the selected item's name, (2) the full information for the respective column and (3) the index of the respective column; a column's breadcrumb can be skipped by returning `null` |
 | `breadcrumbs.preventNavigation` | Boolean: set to `true` in order to turn-off the default behaviour of discarding any following selections when double-clicking on a breadcrumbs item |
 | `searchOptions` | Object: enabling the definition of options for the search/filter feature in the header (is disabled by default) – either `searchOptions.fields` or `searchOptions.filterBy` needs to be specified to enable it. the component itself will take care of looking-up sub-schemas (e.g. in `properties`) and also respects `$ref`-erences and has no problem with circular references. |
 | `searchOptions.fields`| Array of strings: each referring to the name of a text field in a JSON Schema (e.g. `["title", "description"]`) in which to search/filter – this applies a case-insensitive contains() check on each of the given fields |
@@ -58,9 +56,26 @@ npm i react-jsonschema-inspector
 | `searchOptions.debounceWait` | Number indicating the delay in milliseconds between the last change to the search term being entered and it actually being applied. This defaults to `200` but may be increased when used with exceptionally large schemas and you experience performance issues. Please refer to the documentation on [`lodash.debounce`](https://lodash.com/docs/4.17.11#debounce). |
 | `searchOptions.debounceMaxWait` | Number indicating the maximum delay in milliseconds after the search term was changed. This defaults to `500`. Please refer to the documentation on [`lodash.debounce`](https://lodash.com/docs/4.17.11#debounce). |
 | `renderItemContent` | Function: custom render function for name of single property/sub-schema in a column. Receives one parameter: object with the following properties: "name", "hasNestedItems", "selected", "schemaGroup" |
-| `renderSelectionDetails` | Function: custom render function for the "Details" block on the right for the single property/sub-schema being selected. Receives one parameter: object with the following properties: "itemSchemaGroup", "columnData", "selectionColumnIndex" |
+| `renderSelectionDetails` | Function: custom render function for the "Details" block on the right for the single property/sub-schema being selected. Receives one parameter: object with the following properties: "itemSchemaGroup", "columnData", "selectionColumnIndex", "optionIndexes" |
 | `renderEmptyDetails` | Function: custom render function for the "Details" block on the right if nothing is selected yet. Receives one parameter, which is an object with the "rootColumnSchemas" property, which holds the array of top-level schemas (as derived from the `schemas` prop and augmented by any given `referenceSchemas`)
 
+### Additional Helper Functions
+
+Besides the main `<Inspector>` component, there are additional named helper functions being provided in the scope of this library:
+- `getFieldValueArrayFromSchemaGroup()` – listing all values of the targeted field in an array (skipping `undefined` and `null` values)
+- `getCommonFieldValuesFromSchemaGroup()` – listing only those values of the targeted field in an array that are included in all occurrences of the field not being `undefined` or `null`
+- `getMinimumFieldValueFromSchemaGroup()` – expecting numeric values in the targeted field and returning the single lowest value (ignoring `undefined` and `null` values)
+- `getMaximumFieldValueFromSchemaGroup()` – expecting numeric values in the targeted field and returning the single highest value (ignoring `undefined` and `null` values)
+
+All four of these are intended to be used within props enabling the customisation of an `<Inspector>` instance, e.g. in `onSelect`, `buildArrayProperties`, `breadcrumbs.mutateName`, `renderItemContent`, `renderSelectionDetails`, `renderEmptyDetails`.
+All four helper functions expect the same input parameters:
+1. `schemaGroup` – a group object representing a single schema with all its parts, as provided to the various call-back functions mentioned above
+2. `fieldName` – textual name of the targeted field in the schema (group), e.g. `"title"`, `"maximum"`, `"minLength"`
+3. `defaultValue` – value to return if there is no value for the targeted field; or as initial/base value for the `Array.reduce()` being performed for the encountered values
+4. `optionIndexes` – only provided if the `schemaGroup` contains optional parts (i.e. `anyOf`/`oneOf`); used to identify the particular optional path within the `anyOf`/`oneOf` part(s) – this is also provided in one way or another in those call-back functions listed above
+
+As output, the respective helper functions either return a single value or – in case of multiple values – an array.
+
 
 ## Compatibility
 
@@ -83,8 +98,8 @@ It is also backwards-compatible with Drafts 4 and 6.
 | `items`| Partially | used to look-up `properties` of single kind of items in an array; however if `items` is an array of multiple sub-schemas they are being *ignored* |
 | `additionalItems`| Yes | used to look-up `properties` of kind of items in an array if `items` is not present or defined as an array (which is not supported itself), otherwise `additionalItems` are being *ignored* |
 | `allOf` | Yes | used to combine sub-schemas transparently |
-| `anyOf` | Yes | used to combine sub-schemas (transparently via `parserConfig.anyOf.type === "likeAllOf"` or explicitly via `parserConfig.anyOf.type === "asAdditionalColumn"`) |
-| `oneOf` | Yes | used to combine sub-schemas (transparently via `parserConfig.oneOf.type === "likeAllOf"` or explicitly via `parserConfig.oneOf.type === "asAdditionalColumn"`) |
+| `anyOf` | Yes | used to combine sub-schemas |
+| `oneOf` | Yes | used to combine sub-schemas |
 | `not` | - | *ignored* |
 | `contains` | - | *ignored* |
 | `dependencies` | - | *ignored* |

package.json

@@ -1,6 +1,6 @@
 {
     "name": "react-jsonschema-inspector",
-    "version": "2.0.1",
+    "version": "2.1.0",
     "description": "View component for traversing/searching in a JSON Schema",
     "homepage": "https://CarstenWickner.github.io/react-jsonschema-inspector",
     "author": "Carsten Wickner",

src/component/Inspector.js

@@ -130,7 +130,7 @@ class Inspector extends Component {
      * @return {Object} return wrapper object for the column data (for the sake of future extensibility)
      * @return {Array.<Object>} return.columnData
      * @return {?Object.<String, JsonSchemaGroup>} return.columnData[].items named schemas to list in the respective column
-     * @return {?Object} return.columnData[].options representation of a schema's hierarchy in case of optionals being included `"asAdditionalColumn"`
+     * @return {?Object} return.columnData[].options representation of a schema's hierarchy in case of optionals being included
      * @return {?JsonSchemaGroup} return.columnData[].contextGroup the schema group containing the `options`
      * @return {?String} return.columnData[].selectedItem name of the currently selected item (may be null)
      * @return {?Boolean} return.columnData[].trailingSelection flag indicating whether this column's selection is the last
@@ -232,22 +232,20 @@ Inspector.propTypes = {
      */
     defaultSelectedItems: PropTypes.arrayOf(PropTypes.oneOfType([PropTypes.string, PropTypes.arrayOf(PropTypes.number)])),
     /**
-     * Options for the traversing/parsing of JSON schemas. Enabling the inclusion of optional part of a schema.
+     * Options for the traversing/parsing of JSON schemas. Defining how optional parts of a schema should be represented.
      */
     parserConfig: PropTypes.shape({
         /**
-         * Setting indicating whether/how to include schema parts wrapped in "anyOf".
+         * Setting indicating how to include schema parts wrapped in "anyOf".
          */
         anyOf: PropTypes.shape({
-            type: PropTypes.oneOf(["likeAllOf", "asAdditionalColumn"]).isRequired,
             groupTitle: PropTypes.string,
             optionNameForIndex: PropTypes.func
         }),
         /**
-         * Setting indicating whether/how to include schema parts wrapped in "oneOf".
+         * Setting indicating how to include schema parts wrapped in "oneOf".
          */
         oneOf: PropTypes.shape({
-            type: PropTypes.oneOf(["likeAllOf", "asAdditionalColumn"]).isRequired,
             groupTitle: PropTypes.string,
             optionNameForIndex: PropTypes.func
         })
@@ -326,10 +324,7 @@ Inspector.propTypes = {
 Inspector.defaultProps = {
     referenceSchemas: [],
     defaultSelectedItems: [],
-    parserConfig: {
-        oneOf: { type: "asAdditionalColumn" },
-        anyOf: { type: "asAdditionalColumn" }
-    },
+    parserConfig: {},
     buildArrayProperties: undefined,
     breadcrumbs: {
         skipSeparator: fieldName => (fieldName === "[0]")

src/component/InspectorDetails.js

@@ -11,17 +11,22 @@ const InspectorDetails = ({
     const selectionColumnIndex = columnData.length - (lastColumnContainsSelection ? 1 : 2);
     const trailingSelectionColumn = selectionColumnIndex < 0 ? null : columnData[selectionColumnIndex];
     let itemSchemaGroup;
+    let optionIndexes;
     if (trailingSelectionColumn) {
         itemSchemaGroup = trailingSelectionColumn.items
             ? trailingSelectionColumn.items[trailingSelectionColumn.selectedItem]
             : trailingSelectionColumn.contextGroup;
+        if (trailingSelectionColumn.options) {
+            optionIndexes = trailingSelectionColumn.selectedItem;
+        }
     }
     return (
         <div className="jsonschema-inspector-details">
             {itemSchemaGroup && renderSelectionDetails && renderSelectionDetails({
                 itemSchemaGroup,
                 selectionColumnIndex,
-                columnData
+                columnData,
+                optionIndexes
             })}
             {itemSchemaGroup && !renderSelectionDetails && (
                 <InspectorDetailsContent