blomqma · austinkelleher · Apr 13, 2024 · Apr 13, 2024 · Apr 13, 2024 · Apr 13, 2024
diff --git a/apps/example/openapi-generate.ts b/apps/example/openapi-generate.ts
@@ -0,0 +1,30 @@
+import {
+  compileEndpoints,
+  syncOpenApiSpecFromBuild,
+  clearTmpFolder
+} from 'next-rest-framework/generate';
+
+async function main() {
+  try {
+    await compileEndpoints({
+      buildOptions: {
+        external: ['jsdom']
+      }
+    });
+
+    console.info('Generating OpenAPI spec...');
+
+    await syncOpenApiSpecFromBuild({});
+  } catch (e) {
+    console.error(e);
+    process.exit(1);
+  }
+
+  await clearTmpFolder();
+}
+
+main()
+  .then(() => {
+    console.log('Completed building OpenAPI schema from custom script');
+  })
+  .catch(console.error);
diff --git a/apps/example/package.json b/apps/example/package.json
@@ -7,17 +7,21 @@
     "build": "pnpm prebuild && next build",
     "start": "next start",
     "generate": "pnpm prebuild && next-rest-framework generate",
+    "generate-custom-script": "pnpm prebuild && ts-node ./openapi-generate.ts",
     "validate": "pnpm prebuild && next-rest-framework validate",
     "lint": "tsc && next lint"
   },
   "dependencies": {
+    "jsdom": "^24.0.0",
     "next-rest-framework": "workspace:*",
     "zod-form-data": "2.0.2"
   },
   "devDependencies": {
+    "@types/jsdom": "^21.1.6",
     "autoprefixer": "10.0.1",
+    "eslint-config-next": "14.0.4",
     "postcss": "8.4.33",
     "tailwindcss": "3.3.0",
-    "eslint-config-next": "14.0.4"
+    "ts-node": "10.9.1"
   }
 }
diff --git a/apps/example/public/openapi.json b/apps/example/public/openapi.json
@@ -526,6 +526,31 @@
         }
       }
     },
+    "/api/v2/route-with-external-dep": {
+      "get": {
+        "operationId": "getDomInfo",
+        "responses": {
+          "200": {
+            "description": "Response for status 200",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/GetDomInfo200ResponseBody"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "An unknown error occurred, trying again might help.",
+            "content": {
+              "application/json": {
+                "schema": { "$ref": "#/components/schemas/UnexpectedError" }
+              }
+            }
+          }
+        }
+      }
+    },
     "/api/v2/route-with-params/{slug}": {
       "get": {
         "operationId": "getPathParams",
@@ -978,6 +1003,12 @@
         "additionalProperties": false,
         "description": "Test form response."
       },
+      "GetDomInfo200ResponseBody": {
+        "type": "object",
+        "properties": { "html": { "type": "string" } },
+        "required": ["html"],
+        "additionalProperties": false
+      },
       "GetParams200ResponseBody": {
         "type": "object",
         "properties": {

diff --git a/apps/example/src/app/api/v2/route-with-external-dep/route.ts b/apps/example/src/app/api/v2/route-with-external-dep/route.ts
@@ -0,0 +1,25 @@
+import { TypedNextResponse, route, routeOperation } from 'next-rest-framework';
+import { z } from 'zod';
+import { JSDOM } from 'jsdom';
+
+export const runtime = 'edge';
+
+export const { GET } = route({
+  getDomInfo: routeOperation({
+    method: 'GET'
+  })
+    .outputs([
+      {
+        status: 200,
+        contentType: 'application/json',
+        body: z.object({ html: z.string() })
+      }
+    ])
+    .handler(() => {
+      const dom = new JSDOM('<!DOCTYPE html><p>Hello world</p>');
+
+      return TypedNextResponse.json({
+        html: dom.serialize()
+      });
+    })
+});
diff --git a/apps/example/tsconfig.json b/apps/example/tsconfig.json
@@ -22,6 +22,12 @@
       "@/*": ["./src/*"]
     }
   },
+  "ts-node": {
+    "compilerOptions": {
+      "module": "commonjs",
+      "target": "ES2022"
+    }
+  },
   "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
   "exclude": ["node_modules"]
 }
diff --git a/packages/next-rest-framework/generate.ts b/packages/next-rest-framework/generate.ts
@@ -0,0 +1 @@
+export * from './src/generate';
diff --git a/packages/next-rest-framework/src/cli/index.ts b/packages/next-rest-framework/src/cli/index.ts
@@ -2,9 +2,12 @@
 
 import { Command } from 'commander';
 import chalk from 'chalk';
-import { clearTmpFolder, compileEndpoints } from './utils';
-import { validateOpenApiSpecFromBuild } from './validate';
-import { syncOpenApiSpecFromBuild } from './generate';
+import {
+  clearTmpFolder,
+  compileEndpoints,
+  validateOpenApiSpecFromBuild,
+  syncOpenApiSpecFromBuild
+} from '../generate';
 
 const program = new Command();
 

diff --git a/.../next-rest-framework/src/cli/constants.ts → ...-rest-framework/src/generate/constants.ts b/.../next-rest-framework/src/cli/constants.ts → ...-rest-framework/src/generate/constants.ts
diff --git a/...s/next-rest-framework/src/cli/generate.ts → ...t-rest-framework/src/generate/generate.ts b/...s/next-rest-framework/src/cli/generate.ts → ...t-rest-framework/src/generate/generate.ts
diff --git a/packages/next-rest-framework/src/generate/index.ts b/packages/next-rest-framework/src/generate/index.ts
@@ -0,0 +1,3 @@
+export { clearTmpFolder, compileEndpoints } from './utils';
+export { validateOpenApiSpecFromBuild } from './validate';
+export { syncOpenApiSpecFromBuild } from './generate';
diff --git a/...ages/next-rest-framework/src/cli/utils.ts → ...next-rest-framework/src/generate/utils.ts b/...ages/next-rest-framework/src/cli/utils.ts → ...next-rest-framework/src/generate/utils.ts
@@ -1,7 +1,7 @@
 import { rm } from 'fs/promises';
 import chalk from 'chalk';
 import { globSync } from 'fast-glob';
-import { build } from 'esbuild';
+import { type BuildOptions, build } from 'esbuild';
 import { type NrfOasData } from '../shared/paths';
 import { type NextRestFrameworkConfig } from '../types';
 import { existsSync, readdirSync } from 'fs';
@@ -24,7 +24,9 @@ export const clearTmpFolder = async () => {
 };
 
 // Compile the Next.js routes and API routes to CJS modules with esbuild.
-export const compileEndpoints = async () => {
+export const compileEndpoints = async ({
+  buildOptions
+}: { buildOptions?: BuildOptions } = {}) => {
   await clearTmpFolder();
   console.info(chalk.yellowBright('Compiling endpoints...'));
   const entryPoints = globSync(['./**/*.ts', '!**/node_modules/**']);
@@ -36,10 +38,20 @@ export const compileEndpoints = async () => {
     format: 'cjs',
     platform: 'node',
     outdir: NEXT_REST_FRAMEWORK_TEMP_FOLDER_NAME,
-    outExtension: { '.js': '.cjs' }
+    outExtension: { '.js': '.cjs' },
+    ...buildOptions,
+    external: buildExternalDependencies(buildOptions)
   });
 };
 
+function buildExternalDependencies(buildOptions: BuildOptions = {}): string[] {
+  // explicitly add the `esbuild` as an external build dependency as recommended
+  // by esbuild to avoid bundling it in the output.
+  //
+  // ref: https://github.com/evanw/esbuild//issues/2698#issuecomment-1325160925
+  return ['esbuild', ...(buildOptions.external ?? [])];
+}
+
 // Traverse the base path and find all nested files.
 const getNestedFiles = (basePath: string, dir: string): string[] => {
   const dirents = readdirSync(join(basePath, dir), { withFileTypes: true });
@@ -105,8 +117,7 @@ export const findConfig = async ({ configPath }: { configPath?: string }) => {
               route
             );
 
-            const url = new URL(`file://${filePathToRoute}`).toString();
-            const res = await import(url).then((mod) => mod.default);
+            const res = await dynamicallyImportRoute(filePathToRoute);
 
             const handlers: any[] = Object.entries(res)
               .filter(([key]) => isValidMethod(key))
@@ -165,9 +176,7 @@ export const findConfig = async ({ configPath }: { configPath?: string }) => {
               route
             );
 
-            const url = new URL(`file://${filePathToRoute}`).toString();
-            const res = await import(url).then((mod) => mod.default);
-
+            const res = await dynamicallyImportRoute(filePathToRoute);
             const _config = res.default._nextRestFrameworkConfig;
 
             if (_config) {
@@ -227,6 +236,17 @@ export const findConfig = async ({ configPath }: { configPath?: string }) => {
   return config;
 };
 
+async function dynamicallyImportRoute(filePathToRoute: string) {
+  try {
+    // First try to import the file as a URL and assume it has a default export.
+    // If that fails, try to import the module directly at its absolute path.
+    const url = new URL(`file://${filePathToRoute}`).toString();
+    return await import(url).then((mod) => mod.default);
+  } catch (err) {}
+
+  return await import(filePathToRoute).then((mod) => mod);
+}
+
 // Generate the OpenAPI paths from the Next.js routes and API routes from the build output.
 export const generatePathsFromBuild = async ({
   config
@@ -352,8 +372,7 @@ export const generatePathsFromBuild = async ({
               route
             );
 
-            const url = new URL(`file://${filePathToRoute}`).toString();
-            const res = await import(url).then((mod) => mod.default);
+            const res = await dynamicallyImportRoute(filePathToRoute);
 
             const handlers: any[] = Object.entries(res)
               .filter(([key]) => isValidMethod(key))
@@ -404,8 +423,7 @@ export const generatePathsFromBuild = async ({
               apiRoute
             );
 
-            const url = new URL(`file://${filePathToRoute}`).toString();
-            const res = await import(url).then((mod) => mod.default);
+            const res = await dynamicallyImportRoute(filePathToRoute);
 
             const data = await res.default._getPathsForRoute(
               getApiRouteName(apiRoute)

diff --git a/...s/next-rest-framework/src/cli/validate.ts → ...t-rest-framework/src/generate/validate.ts b/...s/next-rest-framework/src/cli/validate.ts → ...t-rest-framework/src/generate/validate.ts
diff --git a/packages/next-rest-framework/tests/utils.ts b/packages/next-rest-framework/tests/utils.ts
@@ -17,7 +17,7 @@ import { type NextApiRequest, type NextApiResponse } from 'next/types';
 import { type BaseParams, type Modify } from '../src/types';
 import { type OpenAPIV3_1 } from 'openapi-types';
 import { getJsonSchema } from '../src/shared';
-import { OPEN_API_VERSION } from '../src/cli/constants';
+import { OPEN_API_VERSION } from '../src/generate/constants';
 import qs from 'qs';
 
 export const createMockRouteRequest = <Body, Query>({

diff --git a/packages/next-rest-framework/tsup.config.ts b/packages/next-rest-framework/tsup.config.ts
@@ -25,7 +25,8 @@ export default defineConfig({
     'src/index.ts',
     'src/constants.ts',
     'src/client/index.ts',
-    'src/cli/index.ts'
+    'src/cli/index.ts',
+    'src/generate.ts'
   ],
   bundle: true,
   esbuildPlugins: [uaParserDirnamePlugin()],
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		export * from './src/generate';
Copy link Contributor Author austinkelleher Apr 13, 2024 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. This root `generate` file allows us to import with `next-rest-framework/generate` instead of exporting directly from the index file, which prevents `esbuild` from being included in the main bundle. Open to suggestions, but I don't think we want to include `esbuild` in the main bundle.