bugfixes, struct null-check, comment field

Author: Morten Christensen

CHANGELOG.md

@@ -2,4 +2,10 @@ v1.0.0 Initial stable release
 v2.0.0 ES5 retargeting for easier browser compatibility.
        Removed isRoot.
 v2.0.1 Updated dependencies to latest versions, incl. typescript to 2.1.5
-       Arrays in model are now declared as ReadOnly. 
+       Arrays in model are now declared as ReadOnly.
+v2.1.1 Fixed JsonSchema bug.
+       Made values in TypedField nullable
+       Added optional comment fields.
+       Turned on strict null-checks for typescript.
+       Removed test files from distribution npm
+

package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-schema-js-gui-model",
-  "version": "2.0.1",
+  "version": "2.1.1",
   "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",
@@ -18,7 +18,10 @@
     "mapToGuiModel": "dist/cli/index.js"
   },
   "files": [
-    "dist",
+    "dist/cli",
+    "dist/dependencies",
+    "dist/lib",
+    "dist/index*",
     "LICENSE",
     "CHANGELOG.md",
     "README.md"
@@ -44,15 +47,15 @@
     "@types/chai": "3.4.34",
     "@types/core-js": "0.9.35",
     "@types/mocha": "2.2.38",
-    "@types/node": "7.0.0",
+    "@types/node": "7.0.4",
     "chai": "3.5.0",
     "ghooks": "^2.0.0",
     "mocha": "3.2.0",
     "nodemon": "1.11.0",
     "npm-run-all": "4.0.1",
     "rimraf": "2.5.4",
     "ts-npm-lint": "0.1.0",
-    "tslint": "4.3.1",
+    "tslint": "4.4.2",
     "typescript": "2.1.5"
   },
   "engines": {

src/cli/index.ts

@@ -20,7 +20,7 @@ const usageString = 'Usage: ' + npmCmd + ' sourcePath destPath';
 /**
  * Help that abouts with error output
  */
-function failure(msg) {
+function failure(msg: string) {
     console.error(msg);
     exit(-1);
 }
@@ -35,7 +35,7 @@ let sourcePath = userArgs[0];
 let destPath = userArgs[1];
 
 // Read input:
-let source: string;
+let source: string = '';
 
 if (!existsSync(sourcePath)) {
     failure('Error. Could not locate source file \"' + sourcePath + '\".');

src/dependencies/json-schema.ts

@@ -23,7 +23,9 @@
  */
 
 // Adapted from: https://gist.github.com/enriched/c84a2a99f886654149908091a3183e15
-// with following changes: format attribute added.
+// with a few changes such as:
+// * format attribute added.
+// * type of $schema is a string
 
 export interface JsonSchema {
   $ref?: string;
@@ -39,7 +41,7 @@ export interface JsonSchema {
    * It is recommended that the meta-schema is
    * included in the root of any JSON Schema
    */
-  $schema?: JsonSchema;
+  $schema?: string;
   /**
    * Title of the schema
    */

src/lib/gui-model.mapper.ts

@@ -47,7 +47,7 @@ function processProperties(obj: JsonSchema, dataKeyPath: string, schemaPath: str
 /**
  * Process a json schema key/value property definition.  
  */
-function processProperty(key: string, value: any, requiredItem: boolean, keyPath: string, schemaPath: string, accumulatedErrors: TranslationError[]): GuiElement {
+function processProperty(key: string, value: any, requiredItem: boolean, keyPath: string, schemaPath: string, accumulatedErrors: TranslationError[]): GuiElement | null {
     let type = value.type;
     if (!isString(type)) {
         addError(accumulatedErrors, 'Type elements must be strings (not ' + typeof type + ') ', schemaPath);
@@ -75,7 +75,7 @@ function processProperty(key: string, value: any, requiredItem: boolean, keyPath
 
         validateField(type, dataSubType, defaultValue, enumValues, keyPath, schemaPath, requiredItem, accumulatedErrors);
 
-        let prop: GuiElement;
+        let prop: GuiElement | null;
         switch (type) {
             case 'number':  prop = createNumberField(key, keyPath, label, tooltip, defaultValue, requiredItem, dataSubType, enumValues);
                             break;
@@ -141,7 +141,7 @@ function validateField(type: string, dataSubType: SubDataType, defaultValue: any
  * Create an immutable gui input dropdown element for a number, making any contained objects immutable in the process.
  */
 function createNumberField(key: string, objectPath: string, label: string, tooltip: string, defaultValue: number,
-                           required: boolean, dataType: SubDataType, values: number[] = undefined): TypedField<number> {
+                           required: boolean, dataType: SubDataType, values: (number[] | undefined) = undefined): TypedField<number> {
     return Object.freeze<TypedField<number>>({
         kind: 'field',
         name: key,
@@ -161,7 +161,7 @@ function createNumberField(key: string, objectPath: string, label: string, toolt
  * Create an immutable gui input dropdown element for an integer, making any contained objects immutable in the process.
  */
 function createIntegerField(key: string, objectPath: string, label: string, tooltip: string, defaultValue: number,
-                            required: boolean, dataType: SubDataType, values: number[] = undefined): TypedField<number> {
+                            required: boolean, dataType: SubDataType, values: (number[] | undefined) = undefined): TypedField<number> {
     return Object.freeze<TypedField<number>>({
         kind: 'field',
         name: key,
@@ -181,7 +181,7 @@ function createIntegerField(key: string, objectPath: string, label: string, tool
  * Create an immutable gui input element for a boolean, making any contained objects immutable in the process.
  */
 function createBooleanField(key: string, objectPath: string, label: string, tooltip: string, defaultValue: boolean,
-                            required: boolean, dataType: SubDataType, values: boolean[] = undefined): TypedField<boolean> {
+                            required: boolean, dataType: SubDataType, values: (boolean[] | undefined) = undefined): TypedField<boolean> {
     return Object.freeze<TypedField<boolean>>({
         kind: 'field',
         name: key,
@@ -201,7 +201,7 @@ function createBooleanField(key: string, objectPath: string, label: string, tool
  * Create an immutable gui input dropdown element for a string, making any contained objects immutable in the process.
  */
 function createStringField(key: string, objectPath: string, label: string, tooltip: string, defaultValue: string,
-                           required: boolean, dataType: SubDataType, values: string[] = undefined): TypedField<string> {
+                           required: boolean, dataType: SubDataType, values: (string[] | undefined) = undefined): TypedField<string> {
     return Object.freeze<TypedField<string>>({
         kind: 'field',
         name: key,

src/lib/gui-model.ts

@@ -60,6 +60,7 @@ export interface GuiElementBase {
      */
   readonly dataObjectPath: string;
   readonly required: boolean;
+  readonly comment?: string;
 }
 
 
@@ -73,8 +74,8 @@ export interface FieldBase extends GuiElementBase {
 };
 
 export interface TypedField<T> extends FieldBase {
-  readonly defaultValue: T;
-  readonly values?: ReadonlyArray<T>;
+  readonly defaultValue: T | null;
+  readonly values?: ReadonlyArray<T | null>;
 }
 
 /**

tsconfig.json

@@ -13,8 +13,11 @@
         "allowJs": false,
         "removeComments": false,
         "forceConsistentCasingInFileNames": true,
+        "noImplicitAny": true,
         "noImplicitReturns": true,
+        "suppressImplicitAnyIndexErrors": true,
         "noFallthroughCasesInSwitch": true,
+        "strictNullChecks": true,
         "pretty": true,
         "listFiles": false,
         "listEmittedFiles": false