Merge pull request #8 from standardhealth/flux_b

Eliminate namespaces from properties from JSON Schema
standardhealth · May 11, 2018 · 273ffd0 · 273ffd0
2 parents ed88b92 + af5aa50
commit 273ffd0
Show file tree

Hide file tree

Showing 29 changed files with 235 additions and 209 deletions.
diff --git a/lib/export.js b/lib/export.js
@@ -131,9 +131,29 @@ function namespaceToSchema(ns, dataElementsSpecs, baseSchemaURL, baseTypeURL) {
         }
       }
       if (def.fields.length) {
+        const fieldNameMap = {};
+        const clashingNames = {};
         for (const field of def.fields) {
-          if (!(field instanceof TBD) && !isValidField(field) || (field.inheritance === INHERITED)) {
-            continue;
+          if (!(field instanceof TBD)) {
+            if (!isValidField(field)) {
+              continue;
+            } else if (field.inheritance === INHERITED) {
+              if (fieldNameMap[field.identifier.name]) {
+                logger.error(`ERROR: clashing property names: %s and %s ERROR_CODE: 12038`, fieldNameMap[field.identifier.name].fqn, field.identifier.fqn);
+                clashingNames[field.identifier.name] = true;
+              } else {
+                fieldNameMap[field.identifier.name] = field.identifier;
+              }
+              continue;
+            }
+
+            if (fieldNameMap[field.identifier.name]) {
+              logger.error(`ERROR: clashing property names: %s and %s ERROR_CODE: 12038`, fieldNameMap[field.identifier.name].fqn, field.identifier.fqn);
+              clashingNames[field.identifier.name] = true;
+              continue;
+            } else {
+              fieldNameMap[field.identifier.name] = field.identifier;
+            }
           }
           const card = field.effectiveCard;
           if (card && card.isZeroedOut) {
@@ -149,11 +169,16 @@ function namespaceToSchema(ns, dataElementsSpecs, baseSchemaURL, baseTypeURL) {
             needsEntryType = false;
           }
 
-          schemaDef.properties[field.identifier.fqn] = value;
+          schemaDef.properties[field.identifier.name] = value;
           if (required) {
-            requiredProperties.push(field.identifier.fqn);
+            requiredProperties.push(field.identifier.name);
           }
         }
+
+        for (const clashingName in clashingNames) {
+          delete schemaDef.properties[clashingName];
+        }
+        requiredProperties = requiredProperties.filter(propName => !(propName in clashingNames));
       } else if (!def.value) {
         schemaDef.type = 'object';
         schemaDef.description = 'Empty DataElement?';
@@ -177,9 +202,9 @@ function namespaceToSchema(ns, dataElementsSpecs, baseSchemaURL, baseTypeURL) {
         wholeDef.description = descriptionList.join('\n');
       }
       if (needsEntryType) {
-        schemaDef.properties['shr.base.EntryType'] = nonEntryEntryTypeField;
+        schemaDef.properties['EntryType'] = nonEntryEntryTypeField;
         if (def.identifier.fqn !== 'shr.base.EntryType') {
-          requiredProperties.push('shr.base.EntryType');
+          requiredProperties.push('EntryType');
         }
       }
 
@@ -265,10 +290,10 @@ function flatNamespaceToSchema(ns, dataElementsSpecs, baseSchemaURL, baseTypeURL
           continue;
         }
 
-        const qualifiedName = field.identifier.fqn;
-        schemaDef.properties[qualifiedName] = value;
-        if (required && (requiredProperties.indexOf(qualifiedName) === -1)) {
-          requiredProperties.push(qualifiedName);
+        const fieldName = field.identifier.name;
+        schemaDef.properties[fieldName] = value;
+        if (required && (requiredProperties.indexOf(fieldName) === -1)) {
+          requiredProperties.push(fieldName);
         }
       }
       if (def.isEntry) {
@@ -753,11 +778,11 @@ function makeRef(id, enclosingNamespace, baseSchemaURL) {
 function makeShrRefObject(refs, baseTypeURL, target = {}) {
   target.type = 'object';
   target.properties = {
-    ShrId: { type: 'string' },
-    EntryId: { type: 'string' },
-    EntryType: { type: 'string' }
+    _ShrId: { type: 'string' },
+    _EntryId: { type: 'string' },
+    _EntryType: { type: 'string' }
   };
-  target.required = ['ShrId', 'EntryType', 'EntryId'];
+  target.required = ['_ShrId', '_EntryType', '_EntryId'];
   target.refType = refs.map((ref) => `${baseTypeURL}${namespaceToURLPathSegment(ref.identifier.namespace)}/${ref.identifier.name}`);
   return target;
 }
@@ -903,7 +928,7 @@ function extractConstraintPath(constraint, valueDef, dataElementSpecs) {
             }
             return {};
           }
-          normalizedPath.push(pathId.fqn);
+          normalizedPath.push(pathId.name);
         }
       }
       currentDef = newDef;
@@ -961,7 +986,7 @@ function extractUnnormalizedConstraintPath(constraint, valueDef, dataElementSpec
           }
           return {};
         }
-        normalizedPath.push(pathId.fqn);
+        normalizedPath.push(pathId.name);
       }
     }
     currentDef = newDef;

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "shr-json-schema-export",
-  "version": "5.2.3",
+  "version": "5.3.0",
   "description": "Exports SHR data elements from SHR models to JSON Schema",
   "author": "",
   "license": "Apache-2.0",

diff --git a/test/export_test.js b/test/export_test.js
@@ -109,13 +109,13 @@ const stubSchema = JSON.parse(`{
         {
           "type": "object",
           "properties": {
-            "shr.base.ShrId": {
+            "ShrId": {
               "$ref": "#/definitions/RequiredString"
             },
-            "shr.base.EntryId": {
+            "EntryId": {
               "$ref": "#/definitions/RequiredString"
             },
-            "shr.core.CreationTime": {
+            "CreationTime": {
               "type": "object",
               "properties": {
                 "Value": {
@@ -125,15 +125,15 @@ const stubSchema = JSON.parse(`{
               },
               "required": [ "Value" ]
             },
-            "shr.base.LastUpdated": {
+            "LastUpdated": {
               "$ref": "#/definitions/RequiredString"
             }
           },
           "required": [
-            "shr.base.ShrId",
-            "shr.base.EntryId",
-            "shr.core.CreationTime",
-            "shr.base.LastUpdated"
+            "ShrId",
+            "EntryId",
+            "CreationTime",
+            "LastUpdated"
           ]
         }
       ]
@@ -154,16 +154,16 @@ const stubSchema = JSON.parse(`{
       "type": "object",
       "properties": {
         "Value": { "type": "string", "format": "uri" },
-        "shr.base.EntryType": { "$ref": "#/definitions/EntryType" }
+        "EntryType": { "$ref": "#/definitions/EntryType" }
       },
       "required": [ "Value" ]
     },
     "Any": {
       "type": "object",
       "properties": {
-        "shr.base.EntryType": { "$ref": "#/definitions/EntryType" }
+        "EntryType": { "$ref": "#/definitions/EntryType" }
       },
-      "required": [ "shr.base.EntryType" ]
+      "required": [ "EntryType" ]
     }
   }
 }`);
diff --git a/test/fixtures/AbstractAndPlainGroup.schema.json b/test/fixtures/AbstractAndPlainGroup.schema.json
@@ -16,10 +16,10 @@
           {
             "type": "object",
             "properties": {
-              "shr.test.Simple": { "$ref": "#/definitions/Simple" },
-              "shr.test.Plain": { "$ref": "#/definitions/Plain" }
+              "Simple": { "$ref": "#/definitions/Simple" },
+              "Plain": { "$ref": "#/definitions/Plain" }
             },
-            "required": ["shr.test.Simple", "shr.test.Plain"]
+            "required": ["Simple", "Plain"]
           }
         ]
       },
@@ -44,12 +44,12 @@
         "concepts": [ { "code": "bar", "codeSystem": "http://foo.org", "displayText": "Foobar"}],
         "type": "object",
         "properties": {
-          "shr.base.EntryType": { "$ref": "https://standardhealthrecord.org/test/shr/base#/definitions/EntryType" },
+          "EntryType": { "$ref": "https://standardhealthrecord.org/test/shr/base#/definitions/EntryType" },
           "Value": {
             "type": "string"
           }
         },
-        "required": ["Value", "shr.base.EntryType"]
+        "required": ["Value", "EntryType"]
       }
     }
   }

diff --git a/test/fixtures/BooleanAndCodeConstraints.schema.json b/test/fixtures/BooleanAndCodeConstraints.schema.json
@@ -26,7 +26,7 @@
                   { "enum": [ true ] }
                 ]
               },
-              "shr.test.Bool": {
+              "Bool": {
                 "allOf": [
                   {
                     "properties": {
@@ -36,7 +36,7 @@
                   { "$ref": "#/definitions/Bool" }
                 ]
               },
-              "shr.test.Coded": {
+              "Coded": {
                 "properties": {
                   "Value": {
                     "code": { "code": "bar", "codeSystem": "http://foo.org", "displayText": "Foobar"}
@@ -52,12 +52,12 @@
         "type": "object",
         "description": "A boolean element.",
         "properties": {
-          "shr.base.EntryType": {"$ref": "https://standardhealthrecord.org/test/shr/base#/definitions/EntryType" },
+          "EntryType": {"$ref": "https://standardhealthrecord.org/test/shr/base#/definitions/EntryType" },
           "Value": {
             "type": "boolean"
           }
         },
-        "required": ["shr.base.EntryType"]
+        "required": ["EntryType"]
       },
       "Group": {
         "description": "It is a group of elements",
@@ -70,17 +70,17 @@
           {
             "type": "object",
             "properties": {
-              "shr.test.Simple": { "$ref": "#/definitions/Simple" },
-              "shr.test.Coded": { "$ref": "#/definitions/Coded" },
-              "shr.test.ElementValue": {
+              "Simple": { "$ref": "#/definitions/Simple" },
+              "Coded": { "$ref": "#/definitions/Coded" },
+              "ElementValue": {
                 "type": "array",
                 "minItems": 0,
                 "items": {
                   "$ref": "#/definitions/ElementValue"
                 }
               }
             },
-            "required": ["shr.test.Simple"]
+            "required": ["Simple"]
           }
         ]
       },

diff --git a/test/fixtures/ChoiceValueSetConstraint.schema.json b/test/fixtures/ChoiceValueSetConstraint.schema.json
@@ -17,7 +17,7 @@
           {
             "type": "object",
             "properties": {
-              "shr.test.CodedChoice": {
+              "CodedChoice": {
                 "allOf": [
                   {
                     "properties": {

diff --git a/test/fixtures/Group.schema.json b/test/fixtures/Group.schema.json
@@ -23,17 +23,17 @@
           {
             "type": "object",
             "properties": {
-              "shr.test.Simple": { "$ref": "#/definitions/Simple" },
-              "shr.test.Coded": { "$ref": "#/definitions/Coded" },
-              "shr.test.ElementValue": {
+              "Simple": { "$ref": "#/definitions/Simple" },
+              "Coded": { "$ref": "#/definitions/Coded" },
+              "ElementValue": {
                 "type": "array",
                 "minItems": 0,
                 "items": {
                   "$ref": "#/definitions/ElementValue"
                 }
               }
             },
-            "required": ["shr.test.Simple"]
+            "required": ["Simple"]
           }
         ]
       },

diff --git a/test/fixtures/GroupDerivative.schema.json b/test/fixtures/GroupDerivative.schema.json
@@ -39,17 +39,17 @@
           {
             "type": "object",
             "properties": {
-              "shr.test.Simple": { "$ref": "#/definitions/Simple" },
-              "shr.test.Coded": { "$ref": "#/definitions/Coded" },
-              "shr.test.ElementValue": {
+              "Simple": { "$ref": "#/definitions/Simple" },
+              "Coded": { "$ref": "#/definitions/Coded" },
+              "ElementValue": {
                 "type": "array",
                 "minItems": 0,
                 "items": {
                   "$ref": "#/definitions/ElementValue"
                 }
               }
             },
-            "required": ["shr.test.Simple"]
+            "required": ["Simple"]
           }
         ]
       },

diff --git a/test/fixtures/GroupPathClash.schema.json b/test/fixtures/GroupPathClash.schema.json
@@ -15,13 +15,7 @@
           { "$ref": "https://standardhealthrecord.org/test/shr/base#/definitions/Entry" },
           {
             "type": "object",
-            "properties": {
-              "shr.test.Simple": { "$ref": "#/definitions/Simple" },
-              "shr.other.test.Simple": {
-                "$ref": "https://standardhealthrecord.org/test/shr/other/test#/definitions/Simple"
-              }
-            },
-            "required": ["shr.test.Simple"]
+            "properties": {}
           }
         ]
       },

diff --git a/test/fixtures/GroupPathClash_errors.schema.json b/test/fixtures/GroupPathClash_errors.schema.json
@@ -0,0 +1,7 @@
+[
+  {
+    "shrId": "shr.test.GroupPathClash",
+    "level": 50,
+    "msg": "ERROR: clashing property names: shr.test.Simple and shr.other.test.Simple ERROR_CODE: 12038"
+  }
+]
diff --git a/test/fixtures/GroupWithChoiceOfChoice.schema.json b/test/fixtures/GroupWithChoiceOfChoice.schema.json
@@ -35,10 +35,10 @@
                   ]
                 }
               },
-              "shr.test.Simple": { "$ref": "#/definitions/Simple" },
-              "shr.test.Coded": { "$ref": "#/definitions/Coded" }
+              "Simple": { "$ref": "#/definitions/Simple" },
+              "Coded": { "$ref": "#/definitions/Coded" }
             },
-            "required": [ "shr.test.Simple" ]
+            "required": [ "Simple" ]
           }
         ]
       },