Fix items.$ref generation

Author: drwpow

.prettierrc

@@ -1,4 +1,5 @@
 {
+  "printWidth": 100,
   "singleQuote": true,
   "trailingComma": "es5"
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@manifoldco/swagger-to-ts",
-  "version": "1.0.0-alpha.0",
+  "version": "1.0.0",
   "description": "Generate TypeScript types from Swagger OpenAPI specs",
   "main": "dist/cjs",
   "engines": {

scripts/generate.js

@@ -1,43 +1,31 @@
-const { existsSync, mkdirSync, readFileSync, writeFileSync } = require('fs');
 const { resolve, sep } = require('path');
+const { exec } = require('child_process');
 const glob = require('glob');
-const yaml = require('js-yaml');
-const swaggerToGQL = require('../dist'); // replace with: require('@manifoldco/swagger-to-graphql')
 
-// 1. Load all YAML files from a certain directory
-glob(
-  './spec/**/*.yaml',
-  { root: resolve(__dirname, '..') },
-  (error, matches) => {
-    if (error) {
-      console.error('No files found');
-      return;
-    }
+const swaggerToTS = resolve(__dirname, '..', 'bin', 'cli.js');
 
-    if (typeof matches === 'string') {
-      generate(matches);
-      return;
-    }
+// Settings
+const INPUT_DIR = 'spec';
+const OUTPUT_DIR = 'types';
 
-    matches.forEach(file => generate(file));
-  }
-);
+// Methods
+function rename(filename) {
+  return filename
+    .replace(`${sep}${INPUT_DIR}${sep}`, `${sep}${OUTPUT_DIR}${sep}`)
+    .replace(/\.ya?ml$/i, '.ts');
+}
 
-// 2. Convert to GraphQL types, write to `./types` folder.
-function generate(file) {
-  const source = resolve(__dirname, '..', file);
-  const segments = source.split(sep);
-  const dirname = segments[segments.length - 2];
-  const basename = segments[segments.length - 1].replace(/\.yaml$/i, '.ts');
+// Initialize
+glob('./spec/**/*.yaml', { root: resolve(__dirname, '..') }, (error, matches) => {
+  if (error) {
+    console.error('No files found');
+    return;
+  }
 
-  const output = resolve(__dirname, '..', 'types', dirname);
-  if (!existsSync(output)) {
-    mkdirSync(output);
+  if (typeof matches === 'string') {
+    exec(`node ${swaggerToTS} ${matches} -o ${rename(matches)}`);
+    return;
   }
 
-  const schema = swaggerToGQL(
-    yaml.safeLoad(readFileSync(source, 'UTF-8')),
-    dirname
-  );
-  writeFileSync(resolve(output, basename), schema);
-}
+  matches.forEach(file => exec(`node ${swaggerToTS} ${file} -o ${rename(file)}`));
+});

src/index.ts

@@ -1,10 +1,6 @@
 import swagger2, { Swagger2 } from './swagger-2';
 
-export default (
-  spec: Swagger2,
-  namespace?: string,
-  options?: { version?: number }
-) => {
+export default (spec: Swagger2, namespace?: string, options?: { version?: number }) => {
   const version = (options && options.version) || 2;
 
   if (version === 1 || version === 3) {

src/swagger-2.ts

@@ -27,9 +27,7 @@ const TYPES: { [index: string]: string } = {
 const capitalize = (str: string) => `${str[0].toUpperCase()}${str.slice(1)}`;
 
 const camelCase = (name: string) =>
-  name.replace(/(-|_|\.|\s)+[a-z]/g, letter =>
-    letter.toUpperCase().replace(/[^0-9a-z]/gi, '')
-  );
+  name.replace(/(-|_|\.|\s)+[a-z]/g, letter => letter.toUpperCase().replace(/[^0-9a-z]/gi, ''));
 
 const buildTypes = (spec: Swagger2, namespace: string) => {
   const queue: [string, Swagger2Definition][] = [];
@@ -39,16 +37,21 @@ const buildTypes = (spec: Swagger2, namespace: string) => {
   const { definitions } = spec;
 
   function getRef(lookup: string): [string, Swagger2Definition] {
-    const ref = lookup.replace('#/definitions/', '');
-    return [ref, definitions[ref]];
+    const ID = lookup.replace('#/definitions/', '');
+    const ref = definitions[ID];
+    return [ID, ref];
   }
 
   // Returns primitive type, or 'object' or 'any'
-  function getType(definition: Swagger2Definition, nestedName: string) {
+  function getType(definition: Swagger2Definition, nestedName: string): string {
     const { $ref, items, type, ...value } = definition;
 
     if ($ref) {
       const [refName, refProperties] = getRef($ref);
+      // If a shallow array interface, return that instead
+      if (refProperties.items && refProperties.items.$ref) {
+        return getType(refProperties, refName);
+      }
       return TYPES[refProperties.type] || refName || 'any';
     }
 
@@ -110,9 +113,7 @@ const buildTypes = (spec: Swagger2, namespace: string) => {
       return;
     }
     // Open interface
-    const isExtending = includes.length
-      ? ` extends ${includes.join(', ')}`
-      : '';
+    const isExtending = includes.length ? ` extends ${includes.join(', ')}` : '';
 
     output.push(`export interface ${camelCase(ID)}${isExtending} {`);
 
@@ -125,9 +126,7 @@ const buildTypes = (spec: Swagger2, namespace: string) => {
 
       if (typeof value.description === 'string') {
         // Print out descriptions as comments, but only if there’s something there (.*)
-        output.push(
-          `// ${value.description.replace(/\n$/, '').replace(/\n/g, '\n// ')}`
-        );
+        output.push(`// ${value.description.replace(/\n$/, '').replace(/\n/g, '\n// ')}`);
       }
 
       // Save enums for later

types/catalog/v1.ts

@@ -1,4 +1,4 @@
-namespace catalog {
+namespace OpenAPI2 {
   export interface ValueProp {
     // Heading of a value proposition.
     header: string;
@@ -33,7 +33,7 @@ namespace catalog {
     termsUrl?: string;
     featureTypes?: FeatureType[];
     integration?: UpdateProductBodyIntegration;
-    tags?: ProductTags;
+    tags?: string[];
   }
   export interface UpdateProductBodyIntegration {
     provisioning?: string;
@@ -55,7 +55,7 @@ namespace catalog {
     state?: string;
     // Used in conjuction with resizable_to to set or unset the list
     hasResizeConstraints?: boolean;
-    resizableTo?: PlanResizeList;
+    resizableTo?: string[];
     // Array of Region IDs
     regions?: string[];
     // Array of Feature Values
@@ -179,7 +179,7 @@ namespace catalog {
     featureTypes: FeatureType[];
     billing: ProductBodyBilling;
     integration: ProductBodyIntegration;
-    tags?: ProductTags;
+    tags?: string[];
   }
   export interface ProductBodyIntegration {
     provisioning: string;
@@ -225,7 +225,7 @@ namespace catalog {
     name: string;
     label: string;
     state: string;
-    resizableTo?: PlanResizeList;
+    resizableTo?: string[];
     // Array of Region IDs
     regions: string[];
     // Array of Feature Values
@@ -296,7 +296,7 @@ namespace catalog {
     // Sets if this feature’s value is trackable from the provider,
     // this only really affects numeric constraints.
     measurable?: boolean;
-    values?: FeatureValuesList;
+    values?: FeatureValueDetails[];
   }
   export enum FeatureTypeType {
     Boolean = 'boolean',