Removed isRoot, es5 support + improved docs

Author: Morten Christensen

CHANGELOG.md

@@ -0,0 +1,3 @@
+v1.0.0 Initial stable release
+v2.0.0 ES5 retargeting.
+       Removed isRoot.

README.md

@@ -1,5 +1,11 @@
 # json-schema-js-gui-model
-Handy framework-agnostic gui model and associated translator that can be used as a basis when constructing 
+
+Use this library when you need to construct many different custom UI forms that shares common
+characteristics, want to be in charge of how exactly your UI form should present itself, want to
+pick your own web framework for the UI, and want to use a json schema to drive the UI forms
+but finds json schema complex to process and lacking of UI information.
+
+This library contains a handy framework-agnostic gui model and associated translator that can be used as a basis when constructing 
 dynamic javascript UI forms (in any web framework) from json-schemas. For details, refer to the declared gui
 model [here](src/lib/gui-model.ts) and the translator declared at the bottom of this [file](src/lib/gui-model.mapper.ts).
 
@@ -8,7 +14,7 @@ dynamically using the gui model provided by this library. Such UI code will be
 different depending on the exact web framework used and this out of scope of this more
 fundamental and general project.
 
-This library is on purpose keept small with no runtime-dependencies. It can be used from both nodejs v6+ 
+This library is on purpose keept small with few runtime-dependencies. It can be used from both nodejs v6+ 
 and with a modern es6 capable browser.
 
 ## Getting started
@@ -121,7 +127,6 @@ in realtime at each keypress if necessary.
   "dataObjectPath": "",
   "label": "",
   "tooltip": "",
-  "isRoot": true,
   "required": true,
   "elements": [
     {
@@ -131,7 +136,6 @@ in realtime at each keypress if necessary.
       "dataObjectPath": "authentication",
       "label": "Authentication",
       "tooltip": "an authentication description here",
-      "isRoot": false,
       "required": false,
       "elements": [
         {
@@ -191,7 +195,6 @@ in realtime at each keypress if necessary.
       "dataObjectPath": "server",
       "label": "Server",
       "tooltip": "",
-      "isRoot": false,
       "required": false,
       "elements": [
         {
@@ -248,7 +251,8 @@ in realtime at each keypress if necessary.
 
 ## Status and future plans
 
-The current version appears to work fine in my own project but has not been tested beyond that.
+The current version appears to work fine in my own project but has not been tested beyond that. Some advanced
+schema constructs like links are not yet supported.
 
 I am considering to support some kind of json schema ui extensions in order to construct a even more detailed gui model.
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-schema-js-gui-model",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "Handy gui model and associated translator that is useful when constructing javascript UI forms from json-schemas",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -20,6 +20,7 @@
   "files": [
     "dist",
     "LICENSE",
+    "CHANGELOG.md",
     "README.md"
   ],
   "repository": {
@@ -41,6 +42,7 @@
   "homepage": "https://github.com/mmc41/json-schema-js-gui-model#readme",
   "devDependencies": {
     "@types/chai": "3.4.34",
+    "@types/core-js": "0.9.34",
     "@types/mocha": "2.2.32",
     "@types/node": "6.0.46",
     "chai": "3.5.0",
@@ -61,5 +63,8 @@
     "ghooks": {
       "pre-commit": "npm run test"
     }
+  },
+  "dependencies": {
+    "core-js": "2.4.1"
   }
 }

src/lib/constants.ts

@@ -10,7 +10,6 @@ export let EMPTY_GUI_MODEL: GuiModel  = Object.freeze<GuiModel>({
     label: '',
     tooltip: '',
     dataObjectPath: '',
-    isRoot: true,
     required: true,
     elements: [],
     errors: []
@@ -23,7 +22,6 @@ export let EMPTY_GUI_MODEL_GROUP: Group = Object.freeze<Group>({
     label: '',
     tooltip: '',
     dataObjectPath: '',
-    isRoot: false,
     required: true,
     elements: []
 });

src/lib/gui-model.mapper.ts

@@ -1,3 +1,6 @@
+"use strict";
+
+import 'core-js/library';
 import { JsonSchema } from '../dependencies/json-schema';
 import { isString, isNumber, isBoolean, isIntegerNumber, isArray, isObject } from './type-utils';
 
@@ -225,7 +228,6 @@ function createGroupProperty(key: string, objectPath: string, label: string, too
         dataObjectPath: objectPath,
         label: label,
         tooltip: tooltip,
-        isRoot: false,
         required: required,
         elements: Object.freeze(elements)
     });
@@ -282,7 +284,7 @@ export class GuiModelMapper {
   * Converts a json schema into an immutable gui model. In case of errors, the associated error array will be non-empty and the 
   * resulting gui model may be invalid.
   */
-  mapToGuiModel(schema: JsonSchema): GuiModel {
+  public mapToGuiModel(schema: JsonSchema): GuiModel {
     // Setup mutable error reporting array that will have values added during procesing in case of errors.
     let errors: TranslationError[] = [];
 
@@ -304,7 +306,6 @@ export class GuiModelMapper {
       dataObjectPath: '',
       label: '',
       tooltip: '',
-      isRoot: true,
       required: true,
       elements: Object.freeze(result),
       errors: Object.freeze(errors)

src/lib/gui-model.ts

@@ -83,7 +83,6 @@ export interface TypedField<T> extends FieldBase {
 export interface Group extends GuiElementBase {
   readonly kind: 'group';
   readonly elements: GuiElement[];
-  readonly isRoot: boolean;
 }
 
 export interface TranslationError {

src/test/gui-models.ts

@@ -15,8 +15,7 @@ export const simple_gui_model1: GuiModel = Object.freeze<GuiModel>(
     { kind: 'field', name: 'username', controlType: 'input', label: 'username', tooltip: '', dataObjectPath: 'username', defaultValue: '', required: true, type: 'string', subType: 'none' },
     { kind: 'field', name: 'password', controlType: 'input', label: 'password', tooltip: '', dataObjectPath: 'password', defaultValue: '', required: true, type: 'string', subType: 'none' }
   ],
-  errors: [],
-  isRoot: true
+  errors: []
 });
 
 export const simple_gui_model2: GuiModel = Object.freeze<GuiModel>({
@@ -31,8 +30,7 @@ export const simple_gui_model2: GuiModel = Object.freeze<GuiModel>({
     { kind: 'field', name: 'username', controlType: 'input', label: 'user name', tooltip: 'a username description here', dataObjectPath: 'username', defaultValue: 'username default', required: true, type: 'string', subType: 'none' },
     { kind: 'field', name: 'password', controlType: 'input', label: 'password', tooltip: 'a password description here', dataObjectPath: 'password', defaultValue: 'password default', required: true, type: 'string', subType: 'none' }
   ],
-  errors: [],
-  isRoot: true
+  errors: []
 });
 
 export const test_different_elements_gui_model1: GuiModel = Object.freeze<GuiModel>({
@@ -53,8 +51,7 @@ export const test_different_elements_gui_model1: GuiModel = Object.freeze<GuiMod
     { kind: 'field', name: 'rank', controlType: 'dropdown', label: 'Rank', tooltip: 'a rank description here', dataObjectPath: 'rank', defaultValue: 3.14, values: [ 3.14, 0.33, 9.99], required: false, type: 'number', subType: 'none'},
     { kind: 'field', name: 'registered', controlType: 'yesno', label: 'Registered', tooltip: 'a registered description here', dataObjectPath: 'registered', defaultValue: false, required: false, type: 'boolean', subType: 'none' }
   ],
-  errors: [],
-  isRoot: true
+  errors: []
 });
 
 export const test_groups_gui_model1: GuiModel = Object.freeze<GuiModel>({
@@ -67,12 +64,12 @@ export const test_groups_gui_model1: GuiModel = Object.freeze<GuiModel>({
   required: true,
   elements: [
     { kind: 'field', name: 'simple1', controlType: 'input', label: 'A simple field level 1', tooltip: '', dataObjectPath: 'simple1', defaultValue: '', required: false, type: 'string', subType: 'none' },
-    { kind: 'group', name: 'group1', controlType: 'group', label: 'Group at level 1', tooltip: '', dataObjectPath: 'group1', isRoot: false, required: false,
+    { kind: 'group', name: 'group1', controlType: 'group', label: 'Group at level 1', tooltip: '', dataObjectPath: 'group1', required: false,
       elements: [
         { kind: 'field', name: 'simple2', controlType: 'input', label: 'A simple field level 2', tooltip: '', dataObjectPath: 'group1.simple2', defaultValue: '', required: false, type: 'string', subType: 'none' },
-        { kind: 'group', name: 'group2', controlType: 'group', label: 'Group at level 2', tooltip: '', dataObjectPath: 'group1.group2', isRoot: false, required: false,
+        { kind: 'group', name: 'group2', controlType: 'group', label: 'Group at level 2', tooltip: '', dataObjectPath: 'group1.group2', required: false,
           elements: [
-            { kind: 'group', name: 'group3', controlType: 'group', label: 'Group at level 3', tooltip: '', dataObjectPath: 'group1.group2.group3', isRoot: false, required: false,
+            { kind: 'group', name: 'group3', controlType: 'group', label: 'Group at level 3', tooltip: '', dataObjectPath: 'group1.group2.group3', required: false,
               elements: [
                 { kind: 'field', name: 'simple4', controlType: 'input', label: 'A simple field level 4', tooltip: '', dataObjectPath: 'group1.group2.group3.simple4', defaultValue: '', required: false, type: 'string', subType: 'none' }
               ]
@@ -83,8 +80,7 @@ export const test_groups_gui_model1: GuiModel = Object.freeze<GuiModel>({
       ]
     }
   ],
-  errors: [],
-  isRoot: true
+  errors: []
 });
 
 export const complex_gui_model1: GuiModel = Object.freeze<GuiModel>({
@@ -96,31 +92,30 @@ export const complex_gui_model1: GuiModel = Object.freeze<GuiModel>({
   dataObjectPath: '',
   required: true,
   elements: [
-    { kind: 'group', name: 'authentication', controlType: 'group', label: 'Authentication', tooltip: 'an authentication description here', dataObjectPath: 'authentication', isRoot: false, required: true,
+    { kind: 'group', name: 'authentication', controlType: 'group', label: 'Authentication', tooltip: 'an authentication description here', dataObjectPath: 'authentication', required: true,
       elements: [ { kind: 'field', name: 'user', controlType: 'input', label: 'User', tooltip: 'a username', dataObjectPath: 'authentication.user', defaultValue: '', required: true, type: 'string', subType: 'none' },
                   { kind: 'field', name: 'password', controlType: 'input', label: 'Password', tooltip: 'a password', dataObjectPath: 'authentication.password', defaultValue: '', required: true, type: 'string', subType: 'none' },
                   { kind: 'field', name: 'scheme', controlType: 'input', label: 'scheme',  tooltip: '', dataObjectPath: 'authentication.scheme', defaultValue: 'basic', required: true, type: 'string', subType: 'none' },
                   { kind: 'field', name: 'preemptive', controlType: 'yesno', label: 'preemptive',  tooltip: '', dataObjectPath: 'authentication.preemptive', defaultValue: true, required: true, type: 'boolean', subType: 'none'}
                 ]
     },
-    { kind: 'group', name: 'server', controlType: 'group', label: 'Server', tooltip: '', dataObjectPath: 'server', isRoot: false, required: true,
+    { kind: 'group', name: 'server', controlType: 'group', label: 'Server', tooltip: '', dataObjectPath: 'server', required: true,
       elements: [ { kind: 'field', name: 'host', controlType: 'input', label: 'host', tooltip: '', dataObjectPath: 'server.host', defaultValue: '', required: true, type: 'string', subType: 'none' },
                   { kind: 'field', name: 'port', controlType: 'input', label: 'port', tooltip: '', dataObjectPath: 'server.port', defaultValue: 80, required: true, type: 'integer', subType: 'none' },
                   { kind: 'field', name: 'protocol', controlType: 'dropdown', label: 'protocol', tooltip: '', dataObjectPath: 'server.protocol', defaultValue: 'http', values: ['http', 'ftp'], required: true, type: 'string', subType: 'none' }
                 ]
     },
-    { kind: 'group', name: 'testing', controlType: 'group', label: 'Testing', tooltip: '', dataObjectPath: 'testing', isRoot: false, required: false,
+    { kind: 'group', name: 'testing', controlType: 'group', label: 'Testing', tooltip: '', dataObjectPath: 'testing', required: false,
       elements: [ { kind: 'field', name: 'beforeOperationDelay', controlType: 'input', label: 'beforeOperationDelay', tooltip: '', dataObjectPath: 'testing.beforeOperationDelay', defaultValue: 1, required: true, type: 'integer', subType: 'none' },
                   { kind: 'field', name: 'afterOperationDelay', controlType: 'input', label: 'afterOperationDelay', tooltip: '', dataObjectPath: 'testing.afterOperationDelay', defaultValue: 2, required: false, type: 'integer', subType: 'none' }
                 ]
     }
   ],
-  errors: [],
-  isRoot: true
+  errors: []
 });
 
 export const invalid_gui_model1: GuiModel = {
-   kind : 'group', name: '', controlType: 'group', dataObjectPath: '', label: '', tooltip: '', isRoot: true, required: true, elements: [],
+   kind : 'group', name: '', controlType: 'group', dataObjectPath: '', label: '', tooltip: '', required: true, elements: [],
    'errors': [
      { schemaPath: 'properties.username', errorText: 'Unsupported element type string' },
      { schemaPath: 'properties.password', errorText: 'Type elements must be strings (not boolean) ' },

src/test/index.ts

@@ -1,4 +1,7 @@
 /* tslint:disable:max-line-length */
+"use strict";
+
+import 'core-js/library';
 
 import { JsonSchema } from '../dependencies/json-schema';
 import { GuiModelMapper } from '../lib/gui-model.mapper';

tsconfig.json

@@ -3,7 +3,7 @@
     "compilerOptions": {
         "outDir": "dist",
         "rootDir": "src",
-        "target": "es6",
+        "target": "es5",
         "module": "commonjs",
         "moduleResolution": "node",
         "declaration": true,