1717 * under the License.
1818 */
1919
20- const ts = require ( ' typescript' ) ;
21- const fs = require ( 'fs' ) ;
20+ const ts = require ( " typescript" ) ;
21+ const fs = require ( "fs" ) ;
2222
2323/* This library does three things to make openapi-typescript generation easier to use.
2424 * 1. Creates capitalized exports for Paths and Operations
@@ -29,16 +29,16 @@ const fs = require('fs');
2929 */
3030
3131/* Finds all words, capitalizes them, and removes all other characters. */
32- const toPascalCase = ( str ) => (
32+ const toPascalCase = ( str ) =>
3333 ( str . match ( / [ a - z A - Z 0 - 9 ] + / g) || [ ] )
3434 . map ( ( w ) => `${ w . charAt ( 0 ) . toUpperCase ( ) } ${ w . slice ( 1 ) } )
35- . join ( '' )
36- ) ;
35+ . join ( "" ) ;
3736
3837/* Adds a prefix to a type prop as necessary.
3938 * ('', 'components') => 'components'
4039 */
41- const prefixPath = ( rootPrefix , prop ) => ( rootPrefix ? `${ rootPrefix } ${ prop } : prop ) ;
40+ const prefixPath = ( rootPrefix , prop ) =>
41+ rootPrefix ? `${ rootPrefix } ${ prop } : prop ;
4242
4343// Recursively find child nodes by name.
4444const findNode = ( node , ...names ) => {
@@ -58,87 +58,114 @@ const findNode = (node, ...names) => {
5858// Generate Variable Type Aliases for a given path or operation
5959const generateVariableAliases = ( node , operationPath , operationName ) => {
6060 const variableTypes = [ ] ;
61- const hasPath = ! ! findNode ( node , 'parameters' , 'path' ) ;
62- const hasQuery = ! ! findNode ( node , 'parameters' , 'query' ) ;
63- const hasBody = ! ! findNode ( node , 'requestBody' , 'content' , 'application/json' ) ;
61+ const hasPath = ! ! findNode ( node , "parameters" , "path" ) ;
62+ const hasQuery = ! ! findNode ( node , "parameters" , "query" ) ;
63+ const hasBody = ! ! findNode (
64+ node ,
65+ "requestBody" ,
66+ "content" ,
67+ "application/json"
68+ ) ;
6469
6570 if ( hasPath ) variableTypes . push ( `${ operationPath } ) ;
6671 if ( hasQuery ) variableTypes . push ( `${ operationPath } ) ;
67- if ( hasBody ) variableTypes . push ( `${ operationPath } ) ;
72+ if ( hasBody )
73+ variableTypes . push (
74+ `${ operationPath }
75+ ) ;
6876
69- if ( variableTypes . length === 0 ) return '' ;
77+ if ( variableTypes . length === 0 ) return "" ;
7078 const typeName = `${ toPascalCase ( operationName ) } ;
71- return [ typeName , `export type ${ typeName } ${ variableTypes . join ( ' & ' ) } ] ;
79+ return [
80+ typeName ,
81+ `export type ${ typeName } ${ variableTypes . join (
82+ " & "
83+ ) } >;`,
84+ ] ;
7285} ;
7386
7487// Generate Type Aliases
75- const generateAliases = ( rootNode , writeText , prefix = '' ) => {
88+ const generateAliases = ( rootNode , writeText , prefix = "" ) => {
7689 // Loop through the root AST nodes of the file
7790 ts . forEachChild ( rootNode , ( node ) => {
7891 // Response Data Types
79- if ( ts . isInterfaceDeclaration ( node ) && node . name ?. text === 'components' ) {
80- const schemaMemberNames = findNode ( node , 'schemas' ) . type . members . map ( ( n ) => n . name ?. text ) ;
92+ if ( ts . isInterfaceDeclaration ( node ) && node . name ?. text === "components" ) {
93+ const schemaMemberNames = findNode ( node , "schemas" ) . type . members . map (
94+ ( n ) => n . name ?. text
95+ ) ;
8196
8297 const types = schemaMemberNames . map ( ( n ) => [
8398 `${ n } ,
84- `export type ${ n } ${ prefixPath ( prefix , 'components' ) } ${ n } ,
99+ `export type ${ n } ${ prefixPath (
100+ prefix ,
101+ "components"
102+ ) } ['schemas']['${ n } ,
85103 ] ) ;
86104 if ( types . length ) {
87- writeText . push ( [ ' comment' , `Types for returned data ${ prefix } ] ) ;
105+ writeText . push ( [ " comment" , `Types for returned data ${ prefix } ] ) ;
88106 writeText . push ( ...types ) ;
89107 }
90108 }
91109
92110 // Paths referencing an operation are skipped
93- if ( node . name ?. text === ' paths' ) {
111+ if ( node . name ?. text === " paths" ) {
94112 if ( ! prefix ) {
95- writeText . push ( [ ' comment' , ' Alias paths to PascalCase.' ] ) ;
96- writeText . push ( [ ' Paths' , ' export type Paths = paths;' ] ) ;
113+ writeText . push ( [ " comment" , " Alias paths to PascalCase." ] ) ;
114+ writeText . push ( [ " Paths" , " export type Paths = paths;" ] ) ;
97115 }
98116
99117 const types = [ ] ;
100118
101119 ( node . members || node . type . members ) . forEach ( ( path ) => {
102120 const methodNames = path . type . members . map ( ( m ) => m . name . text ) ;
103- const methodTypes = methodNames . map ( ( m ) => (
121+ const methodTypes = methodNames . map ( ( m ) =>
104122 generateVariableAliases (
105123 findNode ( path , m ) ,
106- `${ prefixPath ( prefix , 'paths' ) } ${ path . name ?. text } ${ m } ,
107- `${ path . name . text } ${ toPascalCase ( m ) } ,
108- ) ) ) ;
124+ `${ prefixPath ( prefix , "paths" ) } ${ path . name ?. text } ${ m } ,
125+ `${ path . name . text } ${ toPascalCase ( m ) }
126+ )
127+ ) ;
109128 types . push ( ...methodTypes . filter ( ( m ) => ! ! m ) ) ;
110129 } ) ;
111130
112131 if ( types . length ) {
113- writeText . push ( [ 'comment' , `Types for path operation variables ${ prefix } ] ) ;
132+ writeText . push ( [
133+ "comment" ,
134+ `Types for path operation variables ${ prefix } ,
135+ ] ) ;
114136 writeText . push ( ...types ) ;
115137 }
116138 }
117139
118140 // operationIds are defined
119- if ( node . name ?. text === ' operations' ) {
141+ if ( node . name ?. text === " operations" ) {
120142 if ( ! prefix ) {
121- writeText . push ( [ ' comment' , ' Alias operations to PascalCase.' ] ) ;
122- writeText . push ( [ ' Operations' , ' export type Operations = operations;' ] ) ;
143+ writeText . push ( [ " comment" , " Alias operations to PascalCase." ] ) ;
144+ writeText . push ( [ " Operations" , " export type Operations = operations;" ] ) ;
123145 }
124146
125- const types = ( node . members || node . type . members ) . map ( ( operation ) => (
147+ const types = ( node . members || node . type . members ) . map ( ( operation ) =>
126148 generateVariableAliases (
127149 operation ,
128- `${ prefixPath ( prefix , 'operations' ) } ${ operation . name . text } ,
129- operation . name . text ,
130- ) ) ) ;
150+ `${ prefixPath ( prefix , "operations" ) } ${ operation . name . text } ,
151+ operation . name . text
152+ )
153+ ) ;
131154 if ( types . length ) {
132- writeText . push ( [ ' comment' , `Types for operation variables ${ prefix } ] ) ;
155+ writeText . push ( [ " comment" , `Types for operation variables ${ prefix } ] ) ;
133156 writeText . push ( ...types ) ;
134- writeText . push ( '\n' ) ;
157+ writeText . push ( "\n" ) ;
135158 }
136159 }
137160
138161 // recursively call this for any externals
139- if ( ts . isInterfaceDeclaration ( node ) && node . name ?. text === ' external' ) {
162+ if ( ts . isInterfaceDeclaration ( node ) && node . name ?. text === " external" ) {
140163 node . members . forEach ( ( external ) => {
141- generateAliases ( external . type , writeText , `external['${ external . name . text } ) ;
164+ generateAliases (
165+ external . type ,
166+ writeText ,
167+ `external['${ external . name . text }
168+ ) ;
142169 } ) ;
143170 }
144171 } ) ;
@@ -169,27 +196,32 @@ function generate(file) {
169196 const program = ts . createProgram ( [ file ] , { allowJs : true } ) ;
170197 const sourceFile = program . getSourceFile ( file ) ;
171198 const writeText = [ ] ;
172- writeText . push ( [ ' block' , license ] ) ;
173- writeText . push ( [ ' comment' , ' eslint-disable' ] ) ;
199+ writeText . push ( [ " block" , license ] ) ;
200+ writeText . push ( [ " comment" , " eslint-disable" ] ) ;
174201 // eslint-disable-next-line quotes
175- writeText . push ( [ 'block' , `import type { CamelCasedPropertiesDeep } from 'type-fest';` ] ) ;
176- writeText . push ( [ 'block' , sourceFile . text ] ) ;
202+ writeText . push ( [
203+ "block" ,
204+ `import type { CamelCasedPropertiesDeep } from 'type-fest';` ,
205+ ] ) ;
206+ writeText . push ( [ "block" , sourceFile . text ] ) ;
177207 generateAliases ( sourceFile , writeText ) ;
178208
179209 const finalText = writeText
180210 // Deduplicate types
181211 . map ( ( pair ) => {
182212 // keep all comments and code blocks
183- if ( pair [ 0 ] === ' comment' || pair [ 0 ] === ' block' ) return pair ;
213+ if ( pair [ 0 ] === " comment" || pair [ 0 ] === " block" ) return pair ;
184214 // return the first instance of this key only
185215 const firstInstance = writeText . find ( ( p ) => p [ 0 ] === pair [ 0 ] ) ;
186- return firstInstance === pair ? pair : [ 'comment' , `Duplicate removed: ${ pair [ 1 ] } ] ;
216+ return firstInstance === pair
217+ ? pair
218+ : [ "comment" , `Duplicate removed: ${ pair [ 1 ] } ] ;
187219 } )
188220 // Remove undefined created above
189221 . filter ( ( p ) => ! ! p )
190222 // Escape comments and flatten.
191- . map ( ( pair ) => ( pair [ 0 ] === ' comment' `\n/* ${ pair [ 1 ] } : pair [ 1 ] ) )
192- . join ( '\n' ) ;
223+ . map ( ( pair ) => ( pair [ 0 ] === " comment" `\n/* ${ pair [ 1 ] } : pair [ 1 ] ) )
224+ . join ( "\n" ) ;
193225
194226 fs . writeFileSync ( file , finalText , ( err ) => {
195227 if ( err ) {
0 commit comments