medolino/mongoose-schema-parser

Parse mongoose schema to JSON format

mongoose-schema-parser's Issues

Not handling Arrays without type properly

When using following schema

const SchedulerSchema = new Schema({ crontabParsed: { second: Array, minute: Array, hour: Array, monthday: Array, month: Array, weekday: Array }, });

output is

Scheduler: { schema: crontabParsed: { type: 'Object', schema: { second: { type: 'Function' }, minute: { type: 'Function' }, hour: { type: 'Function' }, monthday: { type: 'Function' }, month: { type: 'Function' }, weekday: { type: 'Function' } } }

but should be

Scheduler: { schema: crontabParsed: { type: 'Object', schema: { second: { type: 'Array' }, minute: { type: 'Array' }, hour: { type: 'Array' }, monthday: { type: 'Array' }, month: { type: 'Array' }, weekday: { type: 'Array' } } }

_id fields are missing in parsed schemas

When using this plugin to parse mongoose schemas, _id field is not present in output

'ref' is missing when type is '[ObjectId]'

When parsing properties that are of type [ObjectId] field ref is not copied to exported schema when it should be

example of schema
{ items: { type: [ObjectId], ref: 'Item' } }

expected output:
{ items: { type: 'ArrayOfObjectId', details: { ref: 'Item' } }, _id: { type: 'ObjectId' } }

actual output:
{ items: { type: 'ArrayOfObjectId' }, _id: { type: 'ObjectId' } }

Detecting type of empty object as though it has another object inside

If schema is

const ApplicationVersionSchema = new Schema({ environmentVariables: { type: {} } });

it is read as

ApplicationVersion: { schema: { environmentVariables: { type: 'Object', schema: { type: { type: 'Object', schema: {} } } } } }

even though it should be read as

ApplicationVersion: { schema: { environmentVariables: { type: 'Object', schema: {} } } }

Failed to parse mongoose schema, when timestamp fields are of type boolean.

Script fails to parse schema, when one of timestamps schema option fields is of type string.

Example:

const SampleSchema = new Schema({
    name: {
      type: String
    }
  }, {
    timestamps: {
      createdAt: 'created_at',
      updatedAt: false
    }
  })

Bug when property "name" is inside nested object

When using following schema

const AnalysisSchema = new Schema({ sort: [{ name: { type: String, trim: true, required: 'missing_name', maxlength: 250 }, type: { type: String, enum: ['ASC', 'DESC'], required: 'missing_type', maxlength: 5 } }], displaySeries: [{ yAxis: { type: String, required: 'missing_yAxis', maxlength: 50 }, chartType: { type: mongoose.Schema.Types.NumberEnum, enum: codelistHelper.getEnums('chartTypes'), required: 'missing_chart_type' }, regressionType: { type: mongoose.Schema.Types.NumberEnum, enum: codelistHelper.getEnums('regressionTypes') } }] });

the two are read as

Analysis: { schema: { sort: { type: 'ArrayOf[object Object]' }, displaySeries: { type: 'ArrayOfObject' }, } }

even though they are both of the same type. This only happens if name is present inside sort