Stop using rest-api-spec altogether

Author: pquentin

compiler/src/compiler.ts

@@ -21,11 +21,7 @@ import { writeFile, mkdir } from 'fs/promises'
 import { join } from 'path'
 import stringify from 'safe-stable-stringify'
 import { Model } from './model/metamodel'
-import {
-  compileEndpoints,
-  compileSpecification
-} from './model/build-model'
-import buildJsonSpec, { JsonSpec } from './model/json-spec'
+import { compileSpecification } from './model/build-model'
 import { ValidationErrors } from './validation-errors'
 
 type StepFunction = (model: Model, errors: ValidationErrors) => Promise<Model>
@@ -41,7 +37,6 @@ type StepFunction = (model: Model, errors: ValidationErrors) => Promise<Model>
 export default class Compiler {
   queue: StepFunction[]
   model: Model
-  jsonSpec: Map<string, JsonSpec>
   errors: ValidationErrors
   specsFolder: string
   outputFolder: string
@@ -54,9 +49,7 @@ export default class Compiler {
   }
 
   generateModel (): this {
-    this.jsonSpec = buildJsonSpec()
-    const endpoints = compileEndpoints(this.jsonSpec)
-    this.model = compileSpecification(endpoints, this.specsFolder, this.outputFolder)
+    this.model = compileSpecification(this.specsFolder, this.outputFolder)
     return this
   }
 

compiler/src/model/build-model.ts

@@ -32,7 +32,6 @@ import {
   TypeAliasDeclaration
 } from 'ts-morph'
 import * as model from './metamodel'
-import { JsonSpec } from './json-spec'
 import {
   assert,
   customTypes,
@@ -57,28 +56,10 @@ import {
   mediaTypeToStringArray
 } from './utils'
 
-export function compileEndpoints (jsonSpec: Map<string, JsonSpec>): Record<string, model.Endpoint> {
-  // Create endpoints and merge them with
-  // the recorded mappings if present.
-  const map = {}
-  for (const [api, spec] of jsonSpec.entries()) {
-    map[api] = {
-      name: api,
-      description: null,
-      docUrl: null,
-      request: null,
-      requestBodyRequired: false,
-      response: null,
-      urls: []
-    }
-    map[api].availability = {}
-  }
-  return map
-}
-
-export function compileSpecification (endpointMappings: Record<string, model.Endpoint>, specsFolder: string, outputFolder: string): model.Model {
+export function compileSpecification (specsFolder: string, outputFolder: string): model.Model {
   const tsConfigFilePath = join(specsFolder, 'tsconfig.json')
   const project = new Project({ tsConfigFilePath })
+  const endpointMappings: Record<string, model.Endpoint> = {}
 
   verifyUniqueness(project)
 
@@ -117,9 +98,6 @@ export function compileSpecification (endpointMappings: Record<string, model.End
     definedButNeverUsed.join('\n'),
     { encoding: 'utf8', flag: 'w' }
   )
-  for (const endpoint of Object.values(endpointMappings)) {
-    model.endpoints.push(endpoint)
-  }
 
   // Visit all class, interface, enum and type alias definitions
   for (const declaration of declarations.classes) {
@@ -141,6 +119,11 @@ export function compileSpecification (endpointMappings: Record<string, model.End
   // Sort the types in alphabetical order
   sortTypeDefinitions(model.types)
 
+  const sortedEndpointKeys = Object.keys(endpointMappings).sort()
+  for (const key of sortedEndpointKeys) {
+    model.endpoints.push(endpointMappings[key])
+  }
+
   return model
 }
 
@@ -191,8 +174,8 @@ function compileClassOrInterfaceDeclaration (declaration: ClassDeclaration | Int
         throw new Error(`Cannot find url template for ${namespace}, very likely the specification folder does not follow the rest-api-spec`)
       }
 
-      if (type.description) {
-        mapping.description = type.description || ''
+      if (type.description !== '' && type.description !== null && type.description !== undefined) {
+        mapping.description = type.description
       }
 
       let pathMember: Node | null = null

compiler/src/model/utils.ts

@@ -35,7 +35,6 @@ import {
   Node,
   Project
 } from 'ts-morph'
-import { closest } from 'fastest-levenshtein'
 import semver from 'semver'
 import chalk from 'chalk'
 import * as model from './metamodel'
@@ -629,6 +628,23 @@ function setTags<TType extends model.BaseType | model.Property | model.EnumMembe
   }
 }
 
+export function updateEndpoints (mappings: Record<string, model.Endpoint>, name: string): model.Endpoint {
+  mappings[name] = {
+    name: name,
+    // @ts-expect-error TODO
+    description: null,
+    // @ts-expect-error TODO
+    docUrl: null,
+    request: null,
+    requestBodyRequired: false,
+    response: null,
+    urls: []
+  }
+  mappings[name].availability = {}
+
+  return mappings[name]
+}
+
 /** Lifts jsDoc type annotations to request properties */
 export function hoistRequestAnnotations (
   request: model.Request, jsDocs: JSDoc[], mappings: Record<string, model.Endpoint>, response: model.TypeName | null
@@ -651,9 +667,7 @@ export function hoistRequestAnnotations (
   assert(jsDocs, apiName !== '' && apiName !== null && apiName !== undefined,
     `Request ${request.name.name} does not declare the @rest_spec_name to link back to`)
 
-  const endpoint = mappings[apiName]
-  assert(jsDocs, endpoint != null, `The api '${apiName}' does not exists, did you mean '${closest(apiName, Object.keys(mappings))}'?`)
-
+  const endpoint = updateEndpoints(mappings, apiName)
   endpoint.request = request.name
   endpoint.response = response