Exclude associations by default

Allow strategy to reject additional properties

Author: techntools

README.md

@@ -28,6 +28,12 @@ oapi.schema('User', schemaManager.generate(UserModel, strategy))
 
 ## Configuration Options
 
+Starting from 1.0.0, additional properties can be rejected
+
+```typescript
+const strategy = new OpenApiStrategy({ additionalProperties: false })
+```
+
 Pass (per) model options to the generate() method:
 
 ```typescript
@@ -44,6 +50,8 @@ const userSchema = schemaManager.generate(userModel, strategy, {
 
 `jsonSchema` and `schema` works the same as sequelize-to-json-schemas
 
+Starting from 1.0.0, associations are excluded by default
+
 ## Unsupported Types
 
 * GEOMETRY

src/schema-manager.ts

@@ -10,7 +10,8 @@ import { pick, omit } from './utils/util'
 export type ModelContainer = {
     type: string,
     properties?: {}
-    required?: string[]
+    required?: string[],
+    additionalProperties: boolean
 }
 
 export type ModelOptions = {
@@ -39,7 +40,7 @@ export default class SchemaManager {
                 {
                     include: [],
                     exclude: [],
-                    associations: true,
+                    associations: false,
                     includeAssociations: [],
                     excludeAssociations: [],
                 },
@@ -137,7 +138,8 @@ export default class SchemaManager {
         const result: ModelContainer = {
             // identical for all models and schemas thus no need to over-engineer
             type: 'object',
-            properties: {}
+            properties: {},
+            additionalProperties: _strategy.get(this).additionalProperties
         }
 
         return result

src/strategies/openapi.ts

@@ -2,6 +2,12 @@ import { Association, ModelValidateOptions } from 'sequelize'
 
 
 export default class OpenApiStrategy {
+    public additionalProperties: boolean
+
+    constructor(options: { additionalProperties?: boolean } = {}) {
+        this.additionalProperties = options.additionalProperties || false
+    }
+
     getPropertyExamples(examples: any[]) {
         return {
             example: examples

test/openapi-strategy.test.ts

@@ -21,8 +21,8 @@ describe('OpenApi3Strategy', function () {
         // generate schema
         // ------------------------------------------------------------------------
         const schemaManager = new SchemaManager
-        const strategy = new OpenApiStrategy
-        const schema = schemaManager.generate(models.User, strategy)
+        const strategy = new OpenApiStrategy({ additionalProperties: true })
+        const schema = schemaManager.generate(models.User, strategy, { associations: true })
 
         // validate document using ajv
         const ajv = new Ajv()
@@ -629,5 +629,9 @@ describe('OpenApi3Strategy', function () {
                 })
             })
         })
+
+        describe("Ensure OpenApiStrategy allows 'additionalProperties'", function () {
+            expect(schema.additionalProperties).toEqual(true)
+        })
     })
 })

test/schema-manager.test.ts

@@ -49,10 +49,10 @@ describe('SchemaManager', function() {
     // ------------------------------------------------------------------------
     // make sure option 'associations' functions as expected
     // ------------------------------------------------------------------------
-    describe(`Ensure option 'associations' with default value 'true':`, function () {
+    describe(`Ensure option 'associations' with user-specificed value 'true':`, function () {
         const schemaManager = new SchemaManager
         const strategy = new OpenApiStrategy
-        const schema = schemaManager.generate(models.User, strategy)
+        const schema = schemaManager.generate(models.User, strategy, { associations: true })
 
         it(`generates association property 'profile'`, function () {
             expect(schema.properties).toHaveProperty('profile')
@@ -63,12 +63,10 @@ describe('SchemaManager', function() {
         })
     })
 
-    describe(`Ensure option 'associations' with user-specificed value 'false':`, function () {
+    describe(`Ensure option 'associations' with default value 'false':`, function () {
         const schemaManager = new SchemaManager
         const strategy = new OpenApiStrategy
-        const schema = schemaManager.generate(models.User, strategy, {
-            associations: false,
-        })
+        const schema = schemaManager.generate(models.User, strategy)
 
         it(`does not generate association property 'profile'`, function () {
             expect(schema.properties!['profile']).toBeUndefined()
@@ -88,6 +86,7 @@ describe('SchemaManager', function() {
         const strategy = new OpenApiStrategy
         const schema = schemaManager.generate(models.User, strategy, {
             includeAssociations: ['profile'],
+            associations: true
         });
 
         it(`include association 'profile'`, function () {
@@ -107,6 +106,7 @@ describe('SchemaManager', function() {
         const strategy = new OpenApiStrategy
         const schema = schemaManager.generate(models.User, strategy, {
             excludeAssociations: ['profile'],
+            associations: true
         });
 
         it(`do not include association 'profile'`, function () {