Add namespace support

Author: drwpow

README.md

@@ -1,13 +1,26 @@
-Node script that can convert Swagger files to TypeScript interfaces. This uses
-[prettier][prettier] to format the interfaces to be somewhat human-readable.
+Convert Swagger files to TypeScript interfaces using Node.js. This uses
+[Prettier][prettier] to prettify the interfaces.
 
 ### Installation
 
 ```shell
 npm i --save-dev @manifoldco/swagger-to-ts
 ```
 
-### Generating
+### Usage
+
+The function takes 2 parameters: a **filepath** to a JSON file, and a
+**namespace** for the API. Namespace is required because it’s very likely
+entities within the Swagger spec will collide with some other type in your
+system, but you still want to access something predictably-named.
+
+```js
+const swaggerToTS = require('swagger-to-ts');
+
+const filepath = './path/to/my/file.json';
+const namespace = 'MySpec';
+const typeData = swaggerToJS(filepath, namespace);
+```
 
 #### From Swagger JSON
 
@@ -16,10 +29,14 @@ const { readFileSync, writeFileSync } = require('fs');
 const swaggerToTS = require('swagger-to-ts');
 
 const file = './spec/swagger.json';
-const typeData = swaggerToTS(readFileSync(file, 'UTF-8'));
+const typeData = swaggerToTS(readFileSync(file, 'UTF-8'), 'MySpec');
 writeFileSync('./types/swagger.ts'), typeData);
 ```
 
+```js
+import MySpec from './types/swagger.ts';
+```
+
 #### From Swagger YAML
 
 Swagger files must be passed to `swaggerToTS()` in a JSON format, so you’ll
@@ -31,10 +48,14 @@ const { readFileSync, writeFileSync } = require('fs');
 const yaml = require('js-yaml');
 
 const file = './spec/swagger.json';
-const typeData = swaggerToTS(yaml.safeLoad(fs.readFileSync(file, 'UTF-8')));
+const typeData = swaggerToTS(yaml.safeLoad(fs.readFileSync(file, 'UTF-8')), 'MySpec');
 writeFileSync('./types/swagger.ts'), typeData);
 ```
 
+```js
+import MySpec from './types/swagger.ts';
+```
+
 #### Generating multiple files
 
 The [glob][glob] package is helpful in converting entire folders. The
@@ -50,8 +71,12 @@ const source1 = glob.sync('./swaggerspec/v1/**/*.yaml');
 const source2 = glob.sync('./swaggerspec/v2/**/*.yaml');
 
 [...source1, ...source2].forEach(file => {
-  const typeData = swaggerToTS(yaml.safeLoad(readFileSync(file, 'UTF-8')));
-  const filename = path.basename(file).replace(/\.ya?ml$/i, '.ts');
+  const basename = path.basename(file);
+  const filename = basename.replace(/\.ya?ml$/i, '.ts');
+  const typeData = swaggerToTS(
+    yaml.safeLoad(readFileSync(file, 'UTF-8')),
+    basename
+  );
   writeFileSync(path.resolve(__dirname, 'types', filename), typeData);
 });
 ```
@@ -70,7 +95,7 @@ const file = './spec/swagger.json';
 console.log('🏗 Generating types…');
 const timeStart = process.hrtime();
 
-const typeData = swaggerToTS(readFileSync(file, 'UTF-8'));
+const typeData = swaggerToTS(readFileSync(file, 'UTF-8'), 'MySpec');
 writeFileSync('./types/swagger.ts'), typeData);
 
 const timeEnd = process.hrtime(timeStart);
@@ -94,9 +119,9 @@ It’s recommended to name the file `*.ts` and `import` the definitions. `*.d.ts
 can’t be imported; they’re meant to be shipped alongside modules.
 
 ```js
-import { User } from '../types/swagger';
+import Swagger from '../types/swagger';
 
-const logIn = (user: User) => {
+const logIn = (user: Swagger.User) => {
   // …
 ```
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@manifoldco/swagger-to-ts",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Convert Swagger files to TypeScript",
   "main": "dist/swaggerToTS.js",
   "scripts": {

src/swaggerToTS.js

@@ -1,9 +1,5 @@
 const { format } = require('prettier'); // eslint-disable-line import/no-extraneous-dependencies
 
-const DEFAULT_OPTIONS = {
-  enum: false,
-};
-
 // Primitives only!
 const TYPES = {
   string: 'string',
@@ -18,12 +14,12 @@ const camelCase = name =>
     letter.toUpperCase().replace(/[^0-9a-z]/gi, '')
   );
 
-const buildTypes = (spec, options) => {
+const buildTypes = (spec, namespace) => {
   const { definitions } = spec;
 
   const queue = [];
   const enumQueue = [];
-  const output = [];
+  const output = [`namespace ${namespace} {`];
 
   const getRef = lookup => {
     const ref = lookup.replace('#/definitions/', '');
@@ -47,7 +43,7 @@ const buildTypes = (spec, options) => {
   };
 
   const buildNextEnum = ([ID, options]) => {
-    output.push(`enum ${ID} {`);
+    output.push(`export enum ${ID} {`);
     options.forEach(option => {
       if (typeof option === 'number') {
         const lastWord = ID.search(/[A-Z](?=[^A-Z]*$)/);
@@ -70,7 +66,7 @@ const buildTypes = (spec, options) => {
     }
 
     // Open interface
-    output.push(`interface ${camelCase(ID)} {`);
+    output.push(`export interface ${camelCase(ID)} {`);
 
     // Populate interface
     Object.entries(properties).forEach(([key, value]) => {
@@ -117,13 +113,12 @@ const buildTypes = (spec, options) => {
     buildNextInterface();
   }
 
+  output.push('}'); // Close namespace
   return output.join('\n');
 };
 
-module.exports = (input, userOptions = {}) => {
-  const options = { ...DEFAULT_OPTIONS, ...userOptions };
-
-  return format(buildTypes(input, options), {
+module.exports = (filename, namespace) => {
+  return format(buildTypes(filename, namespace), {
     parser: 'typescript',
     printWidth: 100,
     singleQuote: true,