feat(model): objects generated as key value maps

Signed-off-by: Vojtech Mašek <[email protected]>

Author: vmasek

src/helper.ts

@@ -1,3 +1,4 @@
+import { Reference } from 'swagger-schema-official';
 import { FileInfix } from './types';
 
 export const BASIC_TS_TYPE_REGEX = /\b(?:string|number|integer|boolean)\b/;
@@ -63,7 +64,7 @@ export function toTypescriptType(type: string | undefined): string {
   } else if (/^string|boolean$/i.test(type)) {
     return type.toLocaleLowerCase();
   } else if (/^object$/i.test(type)) {
-    return 'any';
+    return '{ [key: string]: any }';
   } else if (/^array$/i.test(type)) {
     logWarn('Support for nested arrays is limited, using any[] as type');
     return 'any[]';
@@ -106,3 +107,7 @@ export async function flattenAll<T>(promises: Promise<T[]>[]): Promise<T[]> {
 export function compareStringByKey<T>(key: keyof T): (a: T, b: T) => number {
   return (a, b) => a[key] && b[key] ? `${a[key]}`.localeCompare(`${b[key]}`) : -1;
 }
+
+export function isReference(param: any | Reference): param is Reference { // tslint:disable-line no-any
+  return !!(param as Reference).$ref;
+}

src/parser.ts

@@ -28,6 +28,7 @@ import {
   typeName,
   logWarn,
   compareStringByKey,
+  isReference,
 } from './helper';
 
 interface Parameters {
@@ -84,17 +85,24 @@ export function determineDomain({schemes, host, basePath}: Swagger): string {
   return `${protocol}${domain}${base}`;
 }
 
-function parseMethods({paths, security, parameters}: Swagger, swaggerTag?: string): Method[] {
+function parseMethods({paths, security, parameters, responses = {}}: Swagger, swaggerTag?: string): Method[] {
   const supportedMethods = ['DELETE', 'GET', 'HEAD', 'OPTIONS', 'PATCH', 'POST', 'PUT'];
 
   return ([] as Method[]).concat(...Object.entries(paths)
     .map(([pathName, pathDef]: [string, Path]) =>
-      Object.entries(pathDef).filter(([methodType, operation]) => { // tslint:disable-line:whitespace
+      Object.entries(pathDef).filter(([methodType, operation]) => {
         const op = (<Operation>operation);
         return supportedMethods.indexOf(methodType.toUpperCase()) !== -1 && // skip unsupported methods
           (!swaggerTag || (op.tags && op.tags.includes(swaggerTag))); // if tag is defined take only paths including this tag
       }).map(([methodType, operation]: [string, Operation]) => {
-          const responseType = determineResponseType((operation as any).responses);
+          const okResponse: Response | Reference = operation.responses['200'] || operation.responses['201'];
+
+          const responseType = determineResponseType(
+            okResponse && isReference(okResponse)
+              ? responses[dereferenceType(okResponse.$ref)]
+              : okResponse
+          );
+
           return {
             hasJsonResponse: true,
             isSecure: security !== undefined || operation.security !== undefined,
@@ -305,15 +313,13 @@ function defineInterface(schema: Schema, definitionKey: string): Definition {
   };
 }
 
-function determineResponseType(responses: { [responseName: string]: Response }): ResponseType {
-  const okResponse = responses['200'] || responses['201'];
-
-  if (okResponse == null) { // TODO: check non-200 response codes
+function determineResponseType(response: Response): ResponseType {
+  if (response == null) { // TODO: check non-200 response codes
     logWarn('200 or 201 response not specified; `any` will be used');
     return {name: 'any', type: 'any'};
   }
 
-  const {schema} = okResponse;
+  const {schema} = response;
   if (schema == null) {
     logWarn('200 or 201 response schema not specified; `any` will be used');
     return {name: 'any', type: 'any'};

tests/gcloud-firestore/api/models/status.model.ts

@@ -84,6 +84,6 @@
  */
 export interface Status {
   code: number;  // The status code, which should be an enum value of google.rpc.Code.
-  details: any[];  // A list of messages that carry the error details.  There is a common set ofmessage types for APIs to use.
+  details: { [key: string]: any }[];  // A list of messages that carry the error details.  There is a common set ofmessage types for APIs to use.
   message: string;  // A developer-facing error message, which should be in English. Anyuser-facing error message should be localized and sent in thegoogle.rpc.Status.details field, or localized by the client.
 }

tests/github/api/models/asset.model.ts

@@ -10,6 +10,6 @@ export interface Asset {
   size: number;
   state: string;
   updated_at: string;
-  uploader: any;
+  uploader: { [key: string]: any };
   url: string;
 }

tests/github/api/models/branch.model.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 
 export interface Branch {
-  _links: any;
-  commit: any;
+  _links: { [key: string]: any };
+  commit: { [key: string]: any };
   name: string;
 }

tests/github/api/models/commit-comments.model.ts

@@ -11,5 +11,5 @@ export interface CommitComments {
   position: number;
   updated_at: string;  // ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
   url: string;
-  user: any;
+  user: { [key: string]: any };
 }

tests/github/api/models/commit.model.ts

@@ -1,12 +1,12 @@
 /* tslint:disable */
 
 export interface Commit {
-  author: any;
-  commit: any;
-  committer: any;
-  files: any[];
-  parents: any[];
+  author: { [key: string]: any };
+  commit: { [key: string]: any };
+  committer: { [key: string]: any };
+  files: { [key: string]: any }[];
+  parents: { [key: string]: any }[];
   sha: string;
-  stats: any;
+  stats: { [key: string]: any };
   url: string;
 }

tests/github/api/models/compare-commits.model.ts

@@ -2,11 +2,11 @@
 
 export interface CompareCommits {
   ahead_by: number;
-  base_commit: any;
+  base_commit: { [key: string]: any };
   behind_by: number;
-  commits: any[];
+  commits: { [key: string]: any }[];
   diff_url: string;
-  files: any[];
+  files: { [key: string]: any }[];
   html_url: string;
   patch_url: string;
   permalink_url: string;

tests/github/api/models/contents-path.model.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 
 export interface ContentsPath {
-  _links: any;
+  _links: { [key: string]: any };
   content: string;
   encoding: string;
   git_url: string;

tests/github/api/models/create-file-body.model.ts

@@ -1,7 +1,7 @@
 /* tslint:disable */
 
 export interface CreateFileBody {
-  committer: any;
+  committer: { [key: string]: any };
   content: string;
   message: string;
 }