Add excludeFromJSONSchema option

lib/schema.js

@@ -50,6 +50,7 @@ function schema_jsonSchema(name) {
 schema_jsonSchema.__jsonSchemaIdCounter = 0;
 
 function __build(name, schema) {
+
   const paths = Object
     .keys(schema.paths)
     .filter(path => !/\.\$\*$/.test(path)); // removing Map.item paths
@@ -67,12 +68,14 @@ function __build(name, schema) {
   for (path of paths) {
     jss = ensurePath(result, path);
     sch = schema.paths[path].jsonSchema(jss.prop);
-    jss.cont.properties[jss.prop] = sch;
-    if (sch.__required) {
-      jss.cont.required = jss.cont.required || [];
-      jss.cont.required.push(jss.prop);
+    if (!sch.excludeFromJSONSchema) {
+      jss.cont.properties[jss.prop] = sch;
+      if (sch.__required) {
+        jss.cont.required = jss.cont.required || [];
+        jss.cont.required.push(jss.prop);
+      }
+      delete sch.__required;
     }
-    delete sch.__required;
   }
 
   if (result.required.length === 0) delete result.required;

lib/types.js

@@ -147,6 +147,9 @@ function __processOptions(t, type) {
   t.description = type.description || type.descr || type.ref && `Refers to ${type.ref}`;
   if (!t.description) delete t.description;
 
+  t.excludeFromJSONSchema = type.excludeFromJSONSchema;
+  if (!t.excludeFromJSONSchema) delete t.excludeFromJSONSchema;
+
   if (!t.title && type.title) t.title = type.title;
 
   const customFieldsMapping = config.get(FIELDS_MAPPING);

test/suites/exclude.test.js

@@ -0,0 +1,64 @@
+
+const mongoose = require('../../index')(require('mongoose'));
+const assert = require('assert');
+
+
+describe('Exclude: Schema.jsonSchema()', () => {
+  it('should exclude fields marked with excludeFromJSONSchema = true', () => {
+
+    const mSchema = new mongoose.Schema({
+      s: {
+        type: String,
+        excludeFromJSONSchema: true,
+      },
+      c: {
+        type: String,
+        required: true,
+      }
+    });
+
+    const jsonSchema = mSchema.jsonSchema();
+
+    assert.equal(jsonSchema.properties.s, undefined);
+  });
+
+
+
+  it('should not exclude fields with excludeFromJSONSchema = false', () => {
+
+    const mSchema = new mongoose.Schema({
+      s: {
+        type: String,
+        excludeFromJSONSchema: false,
+      },
+      c: {
+        type: String,
+        required: true,
+      }
+    });
+
+    const jsonSchema = mSchema.jsonSchema();
+    assert.ok(!!jsonSchema.properties.s)
+
+  });
+
+  it('should not exclude fields with !excludeFromJSONSchema', () => {
+
+    const mSchema = new mongoose.Schema({
+      s: {
+        type: String,
+        excludeFromJSONSchema: false,
+      },
+      c: {
+        type: String,
+        required: true,
+      }
+    });
+
+    const jsonSchema = mSchema.jsonSchema();
+    assert.ok(!!jsonSchema.properties.c)
+
+  });
+
+
+});