ObjectTypeLiteral support

lukeautry · Aug 23, 2019 · 6d21daf · 6d21daf
1 parent 3bd067b
commit 6d21daf
Show file tree

Hide file tree

Showing 15 changed files with 140 additions and 8 deletions.
diff --git a/src/metadataGeneration/tsoa.ts b/src/metadataGeneration/tsoa.ts
@@ -87,12 +87,13 @@ export namespace Tsoa {
     | 'any'
     | 'refEnum'
     | 'refObject'
+    | 'objectLiteral'
     | 'union'
     | 'intersection';
 
   export type RefTypeLiteral = 'refObject' | 'refEnum';
 
-  export type PrimitiveTypeLiteral = Exclude<TypeStringLiteral, RefTypeLiteral | 'enum' | 'array' | 'void' | 'union' | 'intersection'>;
+  export type PrimitiveTypeLiteral = Exclude<TypeStringLiteral, RefTypeLiteral | 'enum' | 'array' | 'void' | 'objectLiteral' | 'union' | 'intersection'>;
 
   export interface Type {
     dataType: TypeStringLiteral;
@@ -107,6 +108,11 @@ export namespace Tsoa {
     enums: string[];
   }
 
+  export interface ObjectLiteralType extends Type {
+    dataType: 'objectLiteral';
+    properties: Property[];
+  }
+
   export interface ArrayType extends Type {
     dataType: 'array';
     elementType: Type;

diff --git a/src/metadataGeneration/typeResolver.ts b/src/metadataGeneration/typeResolver.ts
@@ -90,7 +90,22 @@ export class TypeResolver {
     }
 
     if (this.typeNode.kind === ts.SyntaxKind.TypeLiteral) {
-      return { dataType: 'any' } as Tsoa.Type;
+      const properties = (this.typeNode as ts.TypeLiteralNode).members
+        .filter(member => member.kind === ts.SyntaxKind.PropertySignature)
+        .reduce((res, propertySignature: ts.PropertySignature) => {
+          const type = new TypeResolver(propertySignature.type as ts.TypeNode, this.current, this.typeNode).resolve();
+
+          return [
+            {
+              name: (propertySignature.name as ts.Identifier).text,
+              required: !propertySignature.questionToken,
+              type,
+            } as Tsoa.Property,
+            ...res,
+          ];
+        }, []);
+
+      return { dataType: 'objectLiteral', properties } as Tsoa.ObjectLiteralType;
     }
 
     if (this.typeNode.kind === ts.SyntaxKind.ObjectKeyword) {

diff --git a/src/swagger/specGenerator.ts b/src/swagger/specGenerator.ts
@@ -79,6 +79,8 @@ export abstract class SpecGenerator {
       return this.getSwaggerTypeForUnionType(type as Tsoa.UnionType);
     } else if (type.dataType === 'intersection') {
       return this.getSwaggerTypeForIntersectionType(type as Tsoa.IntersectionType);
+    } else if (type.dataType === 'objectLiteral') {
+      return this.getSwaggerTypeForObjectLiteral(type as Tsoa.ObjectLiteralType);
     } else {
       return assertNever(type.dataType);
     }
@@ -87,6 +89,24 @@ export abstract class SpecGenerator {
   protected abstract getSwaggerTypeForUnionType(type: Tsoa.UnionType);
 
   protected abstract getSwaggerTypeForIntersectionType(type: Tsoa.IntersectionType);
+  public getSwaggerTypeForObjectLiteral(objectLiteral: Tsoa.ObjectLiteralType): Swagger.Schema {
+    const properties = objectLiteral.properties.reduce((acc, property: Tsoa.Property) => {
+      return {
+        [property.name]: this.getSwaggerType(property.type),
+        ...acc,
+      };
+    }, {});
+
+    const required = objectLiteral.properties.filter(prop => prop.required).map(prop => prop.name);
+
+    // An empty list required: [] is not valid.
+    // If all properties are optional, do not specify the required keyword.
+    return {
+      properties,
+      ...(required && required.length && { required }),
+      type: 'object',
+    };
+  }
 
   protected getSwaggerTypeForReferenceType(referenceType: Tsoa.ReferenceType): Swagger.BaseSchema {
     return {

diff --git a/tests/fixtures/controllers/getController.ts b/tests/fixtures/controllers/getController.ts
@@ -24,6 +24,9 @@ export class GetTestController extends Controller {
     modelsArray: new Array<TestSubModel>(),
     numberArray: [1, 2, 3],
     numberValue: 1,
+    objLiteral: {
+      name: 'a string',
+    },
     object: {
       a: 'a',
     },

diff --git a/tests/fixtures/inversify/managedService.ts b/tests/fixtures/inversify/managedService.ts
@@ -16,6 +16,9 @@ export class ManagedService {
       modelsArray: new Array<TestSubModel>(),
       numberArray: [1, 2, 3],
       numberValue: 1,
+      objLiteral: {
+        name: 'hello',
+      },
       object: {
         a: 'a',
       },

diff --git a/tests/fixtures/services/modelService.ts b/tests/fixtures/services/modelService.ts
@@ -14,6 +14,9 @@ export class ModelService {
       modelsArray: new Array<TestSubModel>(),
       numberArray: [1, 2, 3],
       numberValue: 1,
+      objLiteral: {
+        name: 'hello',
+      },
       object: {
         a: 'a',
       },

diff --git a/tests/fixtures/testModel.ts b/tests/fixtures/testModel.ts
@@ -75,6 +75,18 @@ export interface TestModel extends Model {
   genericNestedArrayKeyword2?: GenericRequest<Array<TypeAliasModel2>>;
   genericNestedArrayCharacter2?: GenericRequest<TypeAliasModel2[]>;
   mixedUnion?: string | TypeAliasModel1;
+
+  objLiteral: {
+    name: string;
+    nested?: {
+      bool: boolean;
+      optional?: number;
+      allOptional: {
+        one?: string;
+        two?: string;
+      };
+    };
+  };
 }
 
 export interface TypeAliasModel1 {
@@ -333,12 +345,6 @@ export class TestClassModel extends TestClassBaseModel {
   stringProperty: string;
   protected protectedStringProperty: string;
 
-  public static typeLiterals = {
-    booleanTypeLiteral: { $type: Boolean },
-    numberTypeLiteral: { $type: Number },
-    stringTypeLiteral: { $type: String },
-  };
-
   /**
    * @param publicConstructorVar This is a description for publicConstructorVar
    */

diff --git a/tests/integration/dynamic-controllers-express-server.spec.ts b/tests/integration/dynamic-controllers-express-server.spec.ts
@@ -937,6 +937,9 @@ describe('Express Server', () => {
       },
       numberArray: [1, 2],
       numberValue: 5,
+      objLiteral: {
+        name: 'hello',
+      },
       object: { foo: 'bar' },
       objectArray: [{ foo1: 'bar1' }, { foo2: 'bar2' }],
       optionalString: 'test1234',

diff --git a/tests/integration/express-server.spec.ts b/tests/integration/express-server.spec.ts
@@ -937,6 +937,9 @@ describe('Express Server', () => {
       },
       numberArray: [1, 2],
       numberValue: 5,
+      objLiteral: {
+        name: 'hello',
+      },
       object: { foo: 'bar' },
       objectArray: [{ foo1: 'bar1' }, { foo2: 'bar2' }],
       optionalString: 'test1234',

diff --git a/tests/integration/hapi-server.spec.ts b/tests/integration/hapi-server.spec.ts
@@ -866,6 +866,9 @@ describe('Hapi Server', () => {
       },
       numberArray: [1, 2],
       numberValue: 5,
+      objLiteral: {
+        name: 'hello',
+      },
       object: { foo: 'bar' },
       objectArray: [{ foo1: 'bar1' }, { foo2: 'bar2' }],
       optionalString: 'test1234',

diff --git a/tests/integration/inversify-server.spec.ts b/tests/integration/inversify-server.spec.ts
@@ -41,6 +41,9 @@ describe('Inversify Express Server', () => {
         },
         numberArray: [1, 2, 3],
         numberValue: 1,
+        objLiteral: {
+          name: 'hello',
+        },
         object: {
           a: 'a',
         },

diff --git a/tests/integration/koa-server-no-additional-allowed.spec.ts b/tests/integration/koa-server-no-additional-allowed.spec.ts
@@ -355,6 +355,9 @@ describe('Koa Server (with noImplicitAdditionalProperties turned on)', () => {
       modelsArray: [{ email: '[email protected]', id: 1 }],
       numberArray: [1, 2],
       numberValue: 5,
+      objLiteral: {
+        name: 'hello',
+      },
       object: { foo: 'bar' },
       objectArray: [{ foo1: 'bar1' }, { foo2: 'bar2' }],
       optionalString: 'test1234',

diff --git a/tests/integration/koa-server.spec.ts b/tests/integration/koa-server.spec.ts
@@ -851,6 +851,9 @@ describe('Koa Server', () => {
       modelsArray: [{ email: '[email protected]', id: 1 }],
       numberArray: [1, 2],
       numberValue: 5,
+      objLiteral: {
+        name: 'hello',
+      },
       object: { foo: 'bar' },
       objectArray: [{ foo1: 'bar1' }, { foo2: 'bar2' }],
       optionalString: 'test1234',

diff --git a/tests/unit/swagger/definitionsGeneration/definitions.spec.ts b/tests/unit/swagger/definitionsGeneration/definitions.spec.ts
@@ -422,6 +422,29 @@ describe('Definition generation', () => {
             expect(propertySchema.type).to.eq('object', `for property ${propertyName}`);
             expect(propertySchema).to.not.haveOwnProperty('additionalProperties', `for property ${propertyName}`);
           },
+          objLiteral: (propertyName, propertySchema) => {
+            expect(propertySchema).to.deep.include({
+              properties: {
+                name: {
+                  type: 'string',
+                },
+                nested: {
+                  properties: {
+                    allOptional: {
+                      properties: { one: { type: 'string' }, two: { type: 'string' } },
+                      type: 'object',
+                    },
+                    bool: { type: 'boolean' },
+                    optional: { format: 'double', type: 'number' },
+                  },
+                  required: ['allOptional', 'bool'],
+                  type: 'object',
+                },
+              },
+              required: ['name'],
+              type: 'object',
+            });
+          },
         };
 
         Object.keys(assertionsPerProperty).forEach(aPropertyName => {
@@ -438,6 +461,11 @@ describe('Definition generation', () => {
           Object.keys(definition.properties!).length,
           `because the swagger spec (${currentSpec.specName}) should only produce property schemas for properties that live on the TypeScript interface.`,
         );
+
+        expect(Object.keys(assertionsPerProperty)).to.length(
+          Object.keys(definition.properties!).length,
+          `because the swagger spec (${currentSpec.specName}) should only produce property schemas for properties that live on the TypeScript interface.`,
+        );
       });
     });
 

diff --git a/tests/unit/swagger/schemaDetails3.spec.ts b/tests/unit/swagger/schemaDetails3.spec.ts
@@ -214,6 +214,29 @@ describe('Definition generation for OpenAPI 3.0.0', () => {
             expect(propertySchema.description).to.eq(undefined, `for property ${propertyName}.description`);
             expect(propertySchema).to.not.haveOwnProperty('additionalProperties', `for property ${propertyName}`);
           },
+          objLiteral: (propertyName, propertySchema) => {
+            expect(propertySchema).to.deep.include({
+              properties: {
+                name: {
+                  type: 'string',
+                },
+                nested: {
+                  properties: {
+                    allOptional: {
+                      properties: { one: { type: 'string' }, two: { type: 'string' } },
+                      type: 'object',
+                    },
+                    bool: { type: 'boolean' },
+                    optional: { format: 'double', type: 'number' },
+                  },
+                  required: ['allOptional', 'bool'],
+                  type: 'object',
+                },
+              },
+              required: ['name'],
+              type: 'object',
+            });
+          },
           object: (propertyName, propertySchema) => {
             expect(propertySchema.type).to.eq('object', `for property ${propertyName}`);
             if (currentSpec.specName === 'specWithNoImplicitExtras') {
@@ -481,6 +504,13 @@ describe('Definition generation for OpenAPI 3.0.0', () => {
             `because the swagger spec (${currentSpec.specName}) should only produce property schemas for properties that live on the TypeScript interface.`,
           );
         });
+
+        it('should have only created schemas for properties on the TypeScript interface', () => {
+          expect(Object.keys(assertionsPerProperty)).to.length(
+            Object.keys(testModel.properties!).length,
+            `because the swagger spec (${currentSpec.specName}) should only produce property schemas for properties that live on the TypeScript interface.`,
+          );
+        });
       });
     });
   });