Merge pull request #4 from manifoldco/dan/improvements/swagger-additionalProperties

enmand · web-flow · commit 41542d1595cc · 2019-02-22T10:41:44.000-04:00
Create interfaces for additionalProperties objects
diff --git a/example/input.yaml b/example/input.yaml
@@ -1544,4 +1544,21 @@ definitions:
       - version
       - type
       - body
-      - provider
+      - provider
+
+  Credentials:
+    type: object
+    description: |
+      Map of configuration variable names to values. Names must match
+      `^[a-zA-Z][a-zA-Z0-9_]{0,999}$`.
+    additionalProperties:
+      type: string
+  FeatureMap:
+    type: object
+    description: A map of feature labels to selected values for customizable features
+    additionalProperties: true
+    x-go-type:
+      type: FeatureMap
+      import:
+        package: github.com/manifoldco/go-manifold
+        alias: manifold
diff --git a/example/output.ts b/example/output.ts
@@ -43,7 +43,7 @@ namespace OpenAPI2 {
     features?: ProductIntegrationFeatures;
   }
   export enum UpdateProductBodyIntegrationVersion {
-    V1 = "v1"
+    V1 = 'v1'
   }
   export interface UpdateProduct {
     id: string;
@@ -87,7 +87,7 @@ namespace OpenAPI2 {
     Version1 = 1
   }
   export enum RegionType {
-    Region = "region"
+    Region = 'region'
   }
   export interface ProviderBody {
     teamId: string;
@@ -104,11 +104,12 @@ namespace OpenAPI2 {
     body: ProviderBody;
   }
   export enum ProviderType {
-    Provider = "provider"
+    Provider = 'provider'
   }
   export enum ProviderVersion {
     Version1 = 1
   }
+  export interface ProductTags {}
   export interface ProductListing {
     // When true, everyone can see the product when requested. When false it will
     // not be visible to anyone except those on the provider team.
@@ -155,8 +156,8 @@ namespace OpenAPI2 {
     region?: ProductIntegrationFeaturesRegion;
   }
   export enum ProductIntegrationFeaturesRegion {
-    UserSpecified = "user-specified",
-    Unspecified = "unspecified"
+    UserSpecified = 'user-specified',
+    Unspecified = 'unspecified'
   }
   export interface ProductBody {
     providerId: string;
@@ -189,19 +190,19 @@ namespace OpenAPI2 {
     features: ProductIntegrationFeatures;
   }
   export enum ProductBodyIntegrationVersion {
-    V1 = "v1"
+    V1 = 'v1'
   }
   export interface ProductBodyBilling {
     type: ProductBodyBillingType;
     currency: ProductBodyBillingCurrency;
   }
   export enum ProductBodyBillingCurrency {
-    Usd = "usd"
+    Usd = 'usd'
   }
   export enum ProductBodyBillingType {
-    MonthlyProrated = "monthly-prorated",
-    MonthlyAnniversary = "monthly-anniversary",
-    AnnualAnniversary = "annual-anniversary"
+    MonthlyProrated = 'monthly-prorated',
+    MonthlyAnniversary = 'monthly-anniversary',
+    AnnualAnniversary = 'annual-anniversary'
   }
   export interface ProductBodyTerms {
     url?: string;
@@ -214,11 +215,12 @@ namespace OpenAPI2 {
     body: ProductBody;
   }
   export enum ProductType {
-    Product = "product"
+    Product = 'product'
   }
   export enum ProductVersion {
     Version1 = 1
   }
+  export interface PlanResizeList {}
   export interface PlanBody {
     providerId: string;
     productId: string;
@@ -244,11 +246,12 @@ namespace OpenAPI2 {
     body: PlanBody;
   }
   export enum PlanType {
-    Plan = "plan"
+    Plan = 'plan'
   }
   export enum PlanVersion {
     Version1 = 1
   }
+  export interface FeatureValuesList {}
   export interface FeatureValueDetails {
     label: string;
     name: string;
@@ -299,9 +302,9 @@ namespace OpenAPI2 {
     values?: FeatureValueDetails[];
   }
   export enum FeatureTypeType {
-    Boolean = "boolean",
-    String = "string",
-    Number = "number"
+    Boolean = 'boolean',
+    String = 'string',
+    Number = 'number'
   }
   export interface FeatureNumericRange {
     // Defines the end of the range ( inclusive ), from the previous, or 0;
@@ -329,6 +332,9 @@ namespace OpenAPI2 {
     suffix?: string;
     costRanges?: FeatureNumericRange[];
   }
+  export interface FeatureMap {
+    [name: string]: any;
+  }
   export interface ExpandedProduct {
     id: string;
     version: ExpandedProductVersion;
@@ -338,7 +344,7 @@ namespace OpenAPI2 {
     provider: Provider;
   }
   export enum ExpandedProductType {
-    Product = "product"
+    Product = 'product'
   }
   export enum ExpandedProductVersion {
     Version1 = 1
@@ -360,7 +366,7 @@ namespace OpenAPI2 {
     body: ExpandedPlanBody;
   }
   export enum ExpandedPlanType {
-    Plan = "plan"
+    Plan = 'plan'
   }
   export enum ExpandedPlanVersion {
     Version1 = 1
@@ -376,6 +382,9 @@ namespace OpenAPI2 {
     // Explanation of the errors
     message: string[];
   }
+  export interface Credentials {
+    [name: string]: string;
+  }
   export interface CreateRegion {
     body: RegionBody;
   }
diff --git a/src/swagger-2.ts b/src/swagger-2.ts
@@ -9,6 +9,7 @@ export interface Swagger2Definition {
   items?: Swagger2Definition;
   oneOf?: Swagger2Definition[];
   properties?: { [index: string]: Swagger2Definition };
+  additionalProperties?: boolean | Swagger2Definition;
   required?: string[];
   type?: 'array' | 'boolean' | 'integer' | 'number' | 'object' | 'string';
 }
@@ -113,7 +114,7 @@ function parse(spec: Swagger2, namespace: string) {
   function buildNextInterface() {
     const nextObject = queue.pop();
     if (!nextObject) return; // Geez TypeScript it’s going to be OK
-    const [ID, { allOf, properties, required }] = nextObject;
+    const [ID, { allOf, properties, required, additionalProperties, type }] = nextObject;
 
     let allProperties = properties || {};
     const includes: string[] = [];
@@ -132,7 +133,12 @@ function parse(spec: Swagger2, namespace: string) {
     }
 
     // If nothing’s here, let’s skip this one.
-    if (!Object.keys(allProperties).length) {
+    if (
+      !Object.keys(allProperties).length &&
+      additionalProperties !== true &&
+      type &&
+      TYPES[type]
+    ) {
       return;
     }
     // Open interface
@@ -162,6 +168,17 @@ function parse(spec: Swagger2, namespace: string) {
       output.push(`${name}: ${type};`);
     });
 
+    if (additionalProperties) {
+      if (<boolean>additionalProperties === true) {
+        output.push(`[name: string]: any`);
+      }
+
+      if ((<Swagger2Definition>additionalProperties).type) {
+        const type = getType(<Swagger2Definition>additionalProperties, '');
+        output.push(`[name: string]: ${type}`);
+      }
+    }
+
     // Close interface
     output.push('}');
 
@@ -181,7 +198,7 @@ function parse(spec: Swagger2, namespace: string) {
 
   output.push('}'); // Close namespace
 
-  return prettier.format(output.join('\n'), { parser: 'typescript' });
+  return prettier.format(output.join('\n'), { parser: 'typescript', singleQuote: true });
 }
 
 export default parse;
diff --git a/tests/swagger-2.test.ts b/tests/swagger-2.test.ts
@@ -8,7 +8,7 @@ import { Swagger2 } from '../src/swagger-2';
 // Let Prettier handle formatting, not the test expectations
 function format(spec: string, namespaced?: boolean) {
   const wrapped = namespaced === false ? spec : `namespace OpenAPI2 { ${spec} }`;
-  return prettier.format(wrapped, { parser: 'typescript' });
+  return prettier.format(wrapped, { parser: 'typescript', singleQuote: true });
 }
 
 describe('Swagger 2 spec', () => {
@@ -249,6 +249,44 @@ describe('Swagger 2 spec', () => {
     });
   });
 
+  it('can deal with additionalProperties: true', () => {
+    const swagger: Swagger2 = {
+      definitions: {
+        FeatureMap: {
+          type: 'object',
+          additionalProperties: true,
+        },
+      },
+    };
+
+    const ts = format(`
+    export interface FeatureMap {
+      [name: string]: any;
+    }`);
+
+    expect(swaggerToTS(swagger)).toBe(ts);
+  });
+
+  it('can deal with additionalProperties of type', () => {
+    const swagger: Swagger2 = {
+      definitions: {
+        Credentials: {
+          type: 'object',
+          additionalProperties: {
+            type: 'string',
+          },
+        },
+      },
+    };
+
+    const ts = format(`
+    export interface Credentials {
+      [name: string]: string;
+    }`);
+
+    expect(swaggerToTS(swagger)).toBe(ts);
+  });
+
   describe('other output', () => {
     it('generates the example output correctly', () => {
       const input = yaml.safeLoad(

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ namespace OpenAPI2 {`
`43`	`43`	`features?: ProductIntegrationFeatures;`
`44`	`44`	`}`
`45`	`45`	`export enum UpdateProductBodyIntegrationVersion {`
`46`		`- V1 = "v1"`
	`46`	`+ V1 = 'v1'`
`47`	`47`	`}`
`48`	`48`	`export interface UpdateProduct {`
`49`	`49`	`id: string;`
`@@ -87,7 +87,7 @@ namespace OpenAPI2 {`
`87`	`87`	`Version1 = 1`
`88`	`88`	`}`
`89`	`89`	`export enum RegionType {`
`90`		`- Region = "region"`
	`90`	`+ Region = 'region'`
`91`	`91`	`}`
`92`	`92`	`export interface ProviderBody {`
`93`	`93`	`teamId: string;`
`@@ -104,11 +104,12 @@ namespace OpenAPI2 {`
`104`	`104`	`body: ProviderBody;`
`105`	`105`	`}`
`106`	`106`	`export enum ProviderType {`
`107`		`- Provider = "provider"`
	`107`	`+ Provider = 'provider'`
`108`	`108`	`}`
`109`	`109`	`export enum ProviderVersion {`
`110`	`110`	`Version1 = 1`
`111`	`111`	`}`
	`112`	`+ export interface ProductTags {}`
`112`	`113`	`export interface ProductListing {`
`113`	`114`	`// When true, everyone can see the product when requested. When false it will`
`114`	`115`	`// not be visible to anyone except those on the provider team.`
`@@ -155,8 +156,8 @@ namespace OpenAPI2 {`
`155`	`156`	`region?: ProductIntegrationFeaturesRegion;`
`156`	`157`	`}`
`157`	`158`	`export enum ProductIntegrationFeaturesRegion {`
`158`		`- UserSpecified = "user-specified",`
`159`		`- Unspecified = "unspecified"`
	`159`	`+ UserSpecified = 'user-specified',`
	`160`	`+ Unspecified = 'unspecified'`
`160`	`161`	`}`
`161`	`162`	`export interface ProductBody {`
`162`	`163`	`providerId: string;`
`@@ -189,19 +190,19 @@ namespace OpenAPI2 {`
`189`	`190`	`features: ProductIntegrationFeatures;`
`190`	`191`	`}`
`191`	`192`	`export enum ProductBodyIntegrationVersion {`
`192`		`- V1 = "v1"`
	`193`	`+ V1 = 'v1'`
`193`	`194`	`}`
`194`	`195`	`export interface ProductBodyBilling {`
`195`	`196`	`type: ProductBodyBillingType;`
`196`	`197`	`currency: ProductBodyBillingCurrency;`
`197`	`198`	`}`
`198`	`199`	`export enum ProductBodyBillingCurrency {`
`199`		`- Usd = "usd"`
	`200`	`+ Usd = 'usd'`
`200`	`201`	`}`
`201`	`202`	`export enum ProductBodyBillingType {`
`202`		`- MonthlyProrated = "monthly-prorated",`
`203`		`- MonthlyAnniversary = "monthly-anniversary",`
`204`		`- AnnualAnniversary = "annual-anniversary"`
	`203`	`+ MonthlyProrated = 'monthly-prorated',`
	`204`	`+ MonthlyAnniversary = 'monthly-anniversary',`
	`205`	`+ AnnualAnniversary = 'annual-anniversary'`
`205`	`206`	`}`
`206`	`207`	`export interface ProductBodyTerms {`
`207`	`208`	`url?: string;`
`@@ -214,11 +215,12 @@ namespace OpenAPI2 {`
`214`	`215`	`body: ProductBody;`
`215`	`216`	`}`
`216`	`217`	`export enum ProductType {`
`217`		`- Product = "product"`
	`218`	`+ Product = 'product'`
`218`	`219`	`}`
`219`	`220`	`export enum ProductVersion {`
`220`	`221`	`Version1 = 1`
`221`	`222`	`}`
	`223`	`+ export interface PlanResizeList {}`
`222`	`224`	`export interface PlanBody {`
`223`	`225`	`providerId: string;`
`224`	`226`	`productId: string;`
`@@ -244,11 +246,12 @@ namespace OpenAPI2 {`
`244`	`246`	`body: PlanBody;`
`245`	`247`	`}`
`246`	`248`	`export enum PlanType {`
`247`		`- Plan = "plan"`
	`249`	`+ Plan = 'plan'`
`248`	`250`	`}`
`249`	`251`	`export enum PlanVersion {`
`250`	`252`	`Version1 = 1`
`251`	`253`	`}`
	`254`	`+ export interface FeatureValuesList {}`
`252`	`255`	`export interface FeatureValueDetails {`
`253`	`256`	`label: string;`
`254`	`257`	`name: string;`
`@@ -299,9 +302,9 @@ namespace OpenAPI2 {`
`299`	`302`	`values?: FeatureValueDetails[];`
`300`	`303`	`}`
`301`	`304`	`export enum FeatureTypeType {`
`302`		`- Boolean = "boolean",`
`303`		`- String = "string",`
`304`		`- Number = "number"`
	`305`	`+ Boolean = 'boolean',`
	`306`	`+ String = 'string',`
	`307`	`+ Number = 'number'`
`305`	`308`	`}`
`306`	`309`	`export interface FeatureNumericRange {`
`307`	`310`	`// Defines the end of the range ( inclusive ), from the previous, or 0;`
`@@ -329,6 +332,9 @@ namespace OpenAPI2 {`
`329`	`332`	`suffix?: string;`
`330`	`333`	`costRanges?: FeatureNumericRange[];`
`331`	`334`	`}`
	`335`	`+ export interface FeatureMap {`
	`336`	`+ [name: string]: any;`
	`337`	`+ }`
`332`	`338`	`export interface ExpandedProduct {`
`333`	`339`	`id: string;`
`334`	`340`	`version: ExpandedProductVersion;`
`@@ -338,7 +344,7 @@ namespace OpenAPI2 {`
`338`	`344`	`provider: Provider;`
`339`	`345`	`}`
`340`	`346`	`export enum ExpandedProductType {`
`341`		`- Product = "product"`
	`347`	`+ Product = 'product'`
`342`	`348`	`}`
`343`	`349`	`export enum ExpandedProductVersion {`
`344`	`350`	`Version1 = 1`
`@@ -360,7 +366,7 @@ namespace OpenAPI2 {`
`360`	`366`	`body: ExpandedPlanBody;`
`361`	`367`	`}`
`362`	`368`	`export enum ExpandedPlanType {`
`363`		`- Plan = "plan"`
	`369`	`+ Plan = 'plan'`
`364`	`370`	`}`
`365`	`371`	`export enum ExpandedPlanVersion {`
`366`	`372`	`Version1 = 1`
`@@ -376,6 +382,9 @@ namespace OpenAPI2 {`
`376`	`382`	`// Explanation of the errors`
`377`	`383`	`message: string[];`
`378`	`384`	`}`
	`385`	`+ export interface Credentials {`
	`386`	`+ [name: string]: string;`
	`387`	`+ }`
`379`	`388`	`export interface CreateRegion {`
`380`	`389`	`body: RegionBody;`
`381`	`390`	`}`