feat: Add route spec extraction command (#134)

seamapi · Jan 16, 2024 · 5c55158 · 5c55158
1 parent 48a65e0
commit 5c55158
Show file tree

Hide file tree

Showing 28 changed files with 296 additions and 17,216 deletions.
diff --git a/README.md b/README.md
@@ -181,6 +181,15 @@ generateOpenAPI({
 })
 ```
 
+### Extracting route specs (Command Line)
+
+Just run `nextlove extract-route-specs` in your project root! It will output a ESM file bundled by esbuild.
+
+Caveats:
+
+- All dependencies and dev dependencies in your `package.json` are automatically marked as external when bundling. This means that you may want to re-bundle the output file if you plan on publishing it as part of a library.
+- By default, API route files aren't allowed to import anything besides dependencies declared in `package.json`. This is to avoid accidentally polluting the bundle. To allow specific imports, use the `--allowed-import-patterns` flag: `--allowed-import-patterns '**/lib/**' --allowed-import-patterns '**/models/**'`
+
 ### Wrap middlewares together using `wrappers`!
 
 ```ts

diff --git a/apps/example-todo-app/lib/middlewares/with-route-spec.ts b/apps/example-todo-app/lib/middlewares/with-route-spec.ts
@@ -5,7 +5,6 @@ import {
 } from "nextlove"
 import { withAuthToken } from "./with-auth-token"
 import { withUserSession } from "./with-user-session"
-export { checkRouteSpec } from "nextlove"
 import * as ZT from "lib/zod"
 import withGlobalMiddlewareAfterAuth from "./with-global-middeware-after-auth"
 

diff --git a/apps/example-todo-app/package.json b/apps/example-todo-app/package.json
@@ -7,6 +7,7 @@
     "build": "rimraf dist && nsm build && tsup ./index.ts --dts --sourcemap && cpy .next dist/.next",
     "build:openapi": "nextlove generate-openapi --packageDir . --apiName 'Example TODO API' --outputFile ./openapi.json",
     "build:type": "nextlove generate-route-types --packageDir .",
+    "build:routespecs": "nextlove extract-route-specs --packageDir . --allowed-import-patterns '**/lib/zod.ts' --allowed-import-patterns '**/pages/api/**/*.ts' --outputFile dist/extracted-route-specs.mjs",
     "start": "next start",
     "lint": "next lint",
     "test": "ava"

diff --git a/apps/example-todo-app/pages/api/todo/add-ignore-invalid-json-response.ts b/apps/example-todo-app/pages/api/todo/add-ignore-invalid-json-response.ts
@@ -1,7 +1,5 @@
-import {
-  withRouteSpecWithoutValidateResponse,
-  checkRouteSpec,
-} from "lib/middlewares"
+import { withRouteSpecWithoutValidateResponse } from "lib/middlewares"
+import { checkRouteSpec } from "nextlove"
 import { z } from "zod"
 import { v4 as uuidv4 } from "uuid"
 

diff --git a/apps/example-todo-app/pages/api/todo/add-with-global-middeware-after-auth.ts b/apps/example-todo-app/pages/api/todo/add-with-global-middeware-after-auth.ts
@@ -1,7 +1,5 @@
-import {
-  checkRouteSpec,
-  withRouteSpecWithGlobalMiddlewareAfterAuth,
-} from "lib/middlewares"
+import { withRouteSpecWithGlobalMiddlewareAfterAuth } from "lib/middlewares"
+import { checkRouteSpec } from "nextlove"
 import { z } from "zod"
 import { v4 as uuidv4 } from "uuid"
 

diff --git a/apps/example-todo-app/pages/api/todo/add.ts b/apps/example-todo-app/pages/api/todo/add.ts
@@ -1,4 +1,5 @@
-import { withRouteSpec, checkRouteSpec } from "lib/middlewares"
+import { withRouteSpec } from "lib/middlewares"
+import { checkRouteSpec } from "nextlove"
 import { z } from "zod"
 import { v4 as uuidv4 } from "uuid"
 

diff --git a/apps/example-todo-app/pages/api/todo/array-query-brackets.ts b/apps/example-todo-app/pages/api/todo/array-query-brackets.ts
@@ -1,7 +1,5 @@
-import {
-  withRouteSpecSupportedArrayFormats,
-  checkRouteSpec,
-} from "lib/middlewares"
+import { withRouteSpecSupportedArrayFormats } from "lib/middlewares"
+import { checkRouteSpec } from "nextlove"
 import { z } from "zod"
 
 export const queryParams = z.object({

diff --git a/apps/example-todo-app/pages/api/todo/array-query-comma.ts b/apps/example-todo-app/pages/api/todo/array-query-comma.ts
@@ -1,7 +1,5 @@
-import {
-  withRouteSpecSupportedArrayFormats,
-  checkRouteSpec,
-} from "lib/middlewares"
+import { withRouteSpecSupportedArrayFormats } from "lib/middlewares"
+import { checkRouteSpec } from "nextlove"
 import { z } from "zod"
 
 export const queryParams = z.object({

diff --git a/apps/example-todo-app/pages/api/todo/array-query-default.ts b/apps/example-todo-app/pages/api/todo/array-query-default.ts
@@ -1,4 +1,5 @@
-import { checkRouteSpec, withRouteSpec } from "lib/middlewares"
+import { withRouteSpec } from "lib/middlewares"
+import { checkRouteSpec } from "nextlove"
 import { z } from "zod"
 
 export const queryParams = z.object({

diff --git a/apps/example-todo-app/pages/api/todo/array-query-repeat.ts b/apps/example-todo-app/pages/api/todo/array-query-repeat.ts
@@ -1,7 +1,5 @@
-import {
-  withRouteSpecSupportedArrayFormats,
-  checkRouteSpec,
-} from "lib/middlewares"
+import { checkRouteSpec } from "nextlove"
+import { withRouteSpecSupportedArrayFormats } from "lib/middlewares"
 import { z } from "zod"
 
 export const queryParams = z.object({

diff --git a/apps/example-todo-app/pages/api/todo/delete-common-params.ts b/apps/example-todo-app/pages/api/todo/delete-common-params.ts
@@ -1,4 +1,5 @@
-import { checkRouteSpec, withRouteSpec } from "lib/middlewares"
+import { checkRouteSpec } from "nextlove"
+import { withRouteSpec } from "lib/middlewares"
 import { NotFoundException } from "nextlove"
 import { TODO_ID } from "tests/fixtures"
 import { z } from "zod"

diff --git a/apps/example-todo-app/pages/api/todo/delete.ts b/apps/example-todo-app/pages/api/todo/delete.ts
@@ -1,4 +1,5 @@
-import { checkRouteSpec, withRouteSpec } from "lib/middlewares"
+import { checkRouteSpec } from "nextlove"
+import { withRouteSpec } from "lib/middlewares"
 import { NotFoundException } from "nextlove"
 import { TODO_ID } from "tests/fixtures"
 import { z } from "zod"

diff --git a/apps/example-todo-app/pages/api/todo/exclude-from-openapi.ts b/apps/example-todo-app/pages/api/todo/exclude-from-openapi.ts
@@ -1,4 +1,5 @@
-import { withRouteSpec, checkRouteSpec } from "lib/middlewares"
+import { checkRouteSpec } from "nextlove"
+import { withRouteSpec } from "lib/middlewares"
 import { z } from "zod"
 
 export const jsonBody = z.object({})

diff --git a/apps/example-todo-app/pages/api/todo/form-add.ts b/apps/example-todo-app/pages/api/todo/form-add.ts
@@ -1,18 +1,13 @@
-import { withRouteSpec, checkRouteSpec } from "lib/middlewares"
+import { checkRouteSpec } from "nextlove"
+import { withRouteSpec } from "lib/middlewares"
 import { z } from "zod"
-import { v4 as uuidv4 } from "uuid"
 import { HttpException } from "nextlove"
-
-export const formData = z.object({
-  id: z.string().uuid().optional().default(uuidv4()),
-  title: z.string(),
-  completed: z.boolean().optional().default(false),
-})
+import { jsonBody } from "./add"
 
 export const route_spec = checkRouteSpec({
   methods: ["POST"],
   auth: "auth_token",
-  formData,
+  formData: jsonBody,
   jsonResponse: z.object({
     ok: z.boolean(),
   }),

diff --git a/apps/example-todo-app/pages/api/todo/get.ts b/apps/example-todo-app/pages/api/todo/get.ts
@@ -1,4 +1,5 @@
-import { checkRouteSpec, withRouteSpec } from "lib/middlewares"
+import { checkRouteSpec } from "nextlove"
+import { withRouteSpec } from "lib/middlewares"
 import { NotFoundException } from "nextlove"
 import { TODO_ID } from "tests/fixtures"
 import { z } from "zod"

diff --git a/apps/example-todo-app/pages/api/todo/index.ts b/apps/example-todo-app/pages/api/todo/index.ts
@@ -1,4 +1,5 @@
-import { checkRouteSpec, withRouteSpec } from "lib/middlewares"
+import { checkRouteSpec } from "nextlove"
+import { withRouteSpec } from "lib/middlewares"
 import { NotFoundException } from "nextlove"
 import { TODO_ID } from "tests/fixtures"
 import { z } from "zod"

diff --git a/apps/example-todo-app/pages/api/todo/list-optional-ids.ts b/apps/example-todo-app/pages/api/todo/list-optional-ids.ts
@@ -1,4 +1,5 @@
-import { checkRouteSpec, withRouteSpec } from "lib/middlewares"
+import { checkRouteSpec } from "nextlove"
+import { withRouteSpec } from "lib/middlewares"
 import { z } from "zod"
 import * as ZT from "lib/zod"
 

diff --git a/apps/example-todo-app/pages/api/todo/list-with-refine.ts b/apps/example-todo-app/pages/api/todo/list-with-refine.ts
@@ -1,4 +1,5 @@
-import { checkRouteSpec, withRouteSpec } from "lib/middlewares"
+import { checkRouteSpec } from "nextlove"
+import { withRouteSpec } from "lib/middlewares"
 import { z } from "zod"
 import * as ZT from "lib/zod"
 

diff --git a/apps/example-todo-app/pages/api/todo/list.ts b/apps/example-todo-app/pages/api/todo/list.ts
@@ -1,4 +1,5 @@
-import { checkRouteSpec, withRouteSpec } from "lib/middlewares"
+import { checkRouteSpec } from "nextlove"
+import { withRouteSpec } from "lib/middlewares"
 import { z } from "zod"
 import * as ZT from "lib/zod"
 

diff --git a/apps/example-todo-app/pages/api/todo/no-validate-body.ts b/apps/example-todo-app/pages/api/todo/no-validate-body.ts
@@ -1,7 +1,5 @@
-import {
-  checkRouteSpec,
-  withRouteSpecWithoutValidateGetRequestBody,
-} from "lib/middlewares"
+import { checkRouteSpec } from "nextlove"
+import { withRouteSpecWithoutValidateGetRequestBody } from "lib/middlewares"
 import { z } from "zod"
 
 export const route_spec = checkRouteSpec({

diff --git a/apps/example-todo-app/tsconfig.json b/apps/example-todo-app/tsconfig.json
@@ -1,6 +1,6 @@
 {
   "compilerOptions": {
-    "target": "es5",
+    "target": "es2020",
     "lib": ["dom", "dom.iterable", "esnext"],
     "allowJs": true,
     "skipLibCheck": true,