feat(openapi-generator): add initial opt-in functionality for generat…

…ing routes

packages/io-ts-http/src/httpRoute.ts

@@ -18,6 +18,7 @@ export type HttpRoute<M extends Method = Method> = {
   readonly method: Uppercase<M>;
   readonly request: HttpRequestCodec<any>;
   readonly response: HttpResponse;
+  readonly generate?: boolean;
 };
 
 export type RequestType<T extends HttpRoute> = t.TypeOf<T['request']>;

packages/openapi-generator/src/apiSpec.ts

@@ -5,7 +5,7 @@ import type { Block } from 'comment-parser';
 import { parsePlainInitializer } from './codec';
 import type { Project } from './project';
 import { resolveLiteralOrIdentifier } from './resolveInit';
-import { parseRoute, type Route } from './route';
+import { RouteWithGenerate, parseRoute, type Route } from './route';
 import { SourceFile } from './sourceFile';
 import { OpenAPIV3 } from 'openapi-types';
 
@@ -79,7 +79,14 @@ export function parseApiSpec(
       if (E.isLeft(routeResultE)) {
         return routeResultE;
       }
-      result.push(routeResultE.right);
+
+      const stripRouteWithGenerate = (route: RouteWithGenerate): Route => {
+        const { generate, ...rest } = route;
+        return rest;
+      };
+
+      if (routeResultE.right.generate)
+        result.push(stripRouteWithGenerate(routeResultE.right));
     }
   }
 

packages/openapi-generator/src/index.ts

@@ -5,7 +5,7 @@ export { convertRoutesToOpenAPI } from './openapi';
 export { optimize } from './optimize';
 export { Project } from './project';
 export { getRefs } from './ref';
-export { parseRoute, type Route } from './route';
+export { parseRoute, type Route, type RouteWithGenerate } from './route';
 export { parseSource } from './sourceFile';
 export { parseTopLevelSymbols } from './symbol';
 export type { Schema } from './ir';

packages/openapi-generator/src/route.ts

@@ -23,6 +23,10 @@ export type Route = {
   comment?: Block;
 };
 
+export type RouteWithGenerate = Route & {
+  generate: boolean;
+};
+
 type Request = {
   parameters: Parameter[];
   body?: Schema;
@@ -202,7 +206,22 @@ function parseRequestSchema(
   }
 }
 
-export function parseRoute(project: Project, schema: Schema): E.Either<string, Route> {
+function parseGenerateField(schema: Schema | undefined): E.Either<string, boolean> {
+  if (schema === undefined) {
+    return E.right(false);
+  }
+
+  if (schema.type !== 'boolean') {
+    return E.left('Route generate field must be a boolean');
+  }
+
+  return E.right(schema.enum![0] as boolean);
+}
+
+export function parseRoute(
+  project: Project,
+  schema: Schema,
+): E.Either<string, RouteWithGenerate> {
   if (schema.type !== 'object') {
     return E.left('Route must be an object');
   }
@@ -235,6 +254,12 @@ export function parseRoute(project: Project, schema: Schema): E.Either<string, R
   }
   const { parameters, body } = requestPropertiesE.right;
 
+  const generateField = schema.properties['generate'];
+  const generateFieldE = parseGenerateField(generateField);
+  if (E.isLeft(generateFieldE)) {
+    return generateFieldE;
+  }
+
   if (schema.properties['response'] === undefined) {
     return E.left('Route must have responses');
   } else if (schema.properties['response'].type !== 'object') {
@@ -246,6 +271,7 @@ export function parseRoute(project: Project, schema: Schema): E.Either<string, R
     method: schema.properties['method'].enum![0] as string,
     parameters,
     response: schema.properties['response'].properties,
+    generate: generateFieldE.right,
     ...(body !== undefined ? { body } : {}),
     ...(schema.comment !== undefined ? { comment: schema.comment } : {}),
   });

packages/openapi-generator/test/apiSpec.test.ts

@@ -68,6 +68,7 @@ const SIMPLE = {
           response: {
             200: t.string,
           },
+          generate: true
         })
       }
     });`,
@@ -96,6 +97,7 @@ const ROUTE_REF = {
       response: {
         200: t.string,
       },
+      generate: true
     });
 
     export const test = h.apiSpec({
@@ -129,6 +131,7 @@ const ACTION_REF = {
         response: {
           200: t.string,
         },
+        generate: true
       }),
     };
 
@@ -169,6 +172,7 @@ const SPREAD = {
           response: {
             200: t.string,
           },
+          generate: true
         })
       }
     };
@@ -204,6 +208,7 @@ const COMPUTED_PROPERTY = {
           response: {
             200: t.string,
           },
+          generate: true
         })
       }
     });`,
@@ -238,6 +243,7 @@ const BASE_URL = {
           response: {
             200: t.string,
           },
+          generate: true
         })
       }
     });`,
@@ -282,6 +288,7 @@ const MISSING_REFERENCE = {
           response: {
             200: t.string,
           },
+          generate: true
         })
       }
     });`,

packages/openapi-generator/test/route.test.ts

@@ -3,12 +3,17 @@ import assert from 'node:assert/strict';
 import test from 'node:test';
 
 import { TestProject } from './testProject';
-import { parseRoute, parsePlainInitializer, type Route } from '../src';
+import {
+  parseRoute,
+  parsePlainInitializer,
+  type Route,
+  type RouteWithGenerate,
+} from '../src';
 
 async function testCase(
   description: string,
   src: string,
-  expected: Record<string, Route>,
+  expected: Record<string, RouteWithGenerate>,
   expectedErrors: string[] = [],
 ) {
   test(description, async () => {
@@ -71,6 +76,7 @@ export const route = h.httpRoute({
   response: {
     200: t.string
   },
+  generate: true
 });
 `;
 
@@ -93,6 +99,7 @@ testCase('simple route', SIMPLE, {
         type: 'string',
       },
     },
+    generate: true,
   },
 });
 
@@ -110,6 +117,7 @@ export const route = h.httpRoute({
   response: {
     200: t.type({}),
   },
+  generate: true
 });
 `;
 
@@ -134,6 +142,7 @@ testCase('path params route', PATH_PARAMS, {
         required: [],
       },
     },
+    generate: true,
   },
 });
 
@@ -174,6 +183,7 @@ testCase('optional query param route', OPTIONAL_QUERY_PARAM, {
         type: 'string',
       },
     },
+    generate: false,
   },
 });
 
@@ -190,6 +200,7 @@ export const route = h.httpRoute({
   response: {
     200: t.string
   },
+  generate: true
 });
 `;
 
@@ -203,6 +214,7 @@ testCase('const request route', REQUEST_REF, {
         type: 'string',
       },
     },
+    generate: true,
   },
 });
 
@@ -219,6 +231,7 @@ export const route = h.httpRoute({
   method: 'GET',
   request: h.httpRequest({}),
   response: responses,
+  generate: true
 });
 `;
 
@@ -230,6 +243,7 @@ testCase('const response route', RESPONSE_REF, {
     response: {
       200: { type: 'string' },
     },
+    generate: true,
   },
 });
 
@@ -254,6 +268,7 @@ export const route = h.httpRoute({
   response: {
     200: t.string
   },
+  generate: true
 });
 `;
 
@@ -291,6 +306,7 @@ testCase('query param union route', QUERY_PARAM_UNION, {
     response: {
       200: { type: 'string' },
     },
+    generate: true,
   },
 });
 
@@ -321,6 +337,7 @@ export const route = h.httpRoute({
   response: {
     200: t.string
   },
+  generate: true
 });
 `;
 
@@ -364,6 +381,7 @@ testCase('path param union route', PATH_PARAM_UNION, {
     response: {
       200: { type: 'string' },
     },
+    generate: true,
   },
 });
 
@@ -388,6 +406,7 @@ export const route = h.httpRoute({
   response: {
     200: t.string
   },
+  generate: true
 });
 `;
 
@@ -418,6 +437,7 @@ testCase('body union route', BODY_UNION, {
     response: {
       200: { type: 'string' },
     },
+    generate: true,
   },
 });
 
@@ -442,6 +462,7 @@ export const route = h.httpRoute({
   response: {
     200: t.string
   },
+  generate: true
 });
 `;
 
@@ -466,6 +487,7 @@ testCase('request intersection route', REQUEST_INTERSECTION, {
     response: {
       200: { type: 'string' },
     },
+    generate: true,
   },
 });
 
@@ -520,6 +542,7 @@ testCase('request body intersection route', BODY_INTERSECTION, {
     response: {
       200: { type: 'string' },
     },
+    generate: false,
   },
 });
 
@@ -550,6 +573,7 @@ testCase('route with operationId', WITH_OPERATION_ID, {
   route: {
     path: '/foo',
     method: 'GET',
+    generate: false,
     parameters: [
       {
         type: 'query',