feat: rename route to staticRoute

Author: ddadaal

.changeset/perfect-turkeys-explode.md

@@ -0,0 +1,6 @@
+---
+"@ddadaal/next-typed-api-routes-runtime": minor
+"@ddadaal/next-typed-api-routes-cli": minor
+---
+
+rename `route` to `staticRoute`. Also export `route` for backward compatibility

example/src/apis/api.ts

@@ -1,6 +1,6 @@
 /* eslint-disable max-len */
 
-import { fromApi, fromTypeboxRoute, fromZodRoute } from "@ddadaal/next-typed-api-routes-runtime/lib/client";
+import { fromStaticRoute, fromTypeboxRoute, fromZodRoute } from "@ddadaal/next-typed-api-routes-runtime/lib/client";
 import { join } from "path";
 import type { LoginSchema } from "src/pages/api/login/[username]";
 import type { RegisterSchema } from "src/pages/api/register/index";
@@ -13,8 +13,8 @@ const basePath = process.env.NEXT_PUBLIC_BASE_PATH || "";
 
 
 export const api = {
-  login: fromApi<LoginSchema>("GET", join(basePath, "/api/login/[username]")),
-  register: fromApi<RegisterSchema>("POST", join(basePath, "/api/register")),
+  login: fromStaticRoute<LoginSchema>("GET", join(basePath, "/api/login/[username]")),
+  register: fromStaticRoute<RegisterSchema>("POST", join(basePath, "/api/register")),
   typeboxRoute: fromTypeboxRoute<typeof TypeboxRouteSchema>("POST", join(basePath, "/api/typeboxRoute/[test]")),
   zodRoute: fromZodRoute<typeof ZodRouteSchema>("POST", join(basePath, "/api/zodRoute/[test]")),
 };

example/src/pages/api/login/[username].ts

@@ -1,5 +1,5 @@
 // Next.js API route support: https://nextjs.org/docs/api-routes/introduction
-import { route } from "@ddadaal/next-typed-api-routes-runtime";
+import { staticRoute } from "@ddadaal/next-typed-api-routes-runtime";
 
 /** You can use types anywhere. Recommend to use import type */
 import type { LoginInfo } from "../../../models/LoginInfo";
@@ -19,7 +19,7 @@ export interface LoginSchema {
 
 }
 
-export default route<LoginSchema>("LoginSchema", (req) => {
+export default staticRoute<LoginSchema>("LoginSchema", (req) => {
   const { password, username } = req.query;
 
   if (username === password) {

example/src/pages/api/register/index.ts

@@ -1,5 +1,5 @@
 // Next.js API route support: https://nextjs.org/docs/api-routes/introduction
-import { route } from "@ddadaal/next-typed-api-routes-runtime";
+import { staticRoute } from "@ddadaal/next-typed-api-routes-runtime";
 
 export interface RegisterSchema {
   method: "POST";
@@ -19,7 +19,7 @@ export interface RegisterSchema {
 
 }
 
-export default route<RegisterSchema>("RegisterSchema", (req) => {
+export default staticRoute<RegisterSchema>("RegisterSchema", (req) => {
   const { password, username } = req.body;
 
   return { 200: { token: username + password } };

packages/cli/src/generateClients.ts

@@ -24,7 +24,7 @@ interface Import {
 export const ApiTypes = {
   zod: { libImport: "fromZodRoute", typeFormat: (typeName: string) => `typeof ${typeName}` },
   typebox: { libImport: "fromTypeboxRoute", typeFormat: (typeName: string) => `typeof ${typeName}` },
-  ajv: { libImport: "fromApi", typeFormat: (typeName: string) => typeName },
+  static: { libImport: "fromStaticRoute", typeFormat: (typeName: string) => typeName },
 };
 
 export type ApiType = keyof typeof ApiTypes;
@@ -117,7 +117,7 @@ async function getApiObject(
                 found = {
                   typeName: interfaceName,
                   method: s.type.literal.text,
-                  apiType: "ajv",
+                  apiType: "static",
                 };
 
                 break;

packages/runtime/src/fetch/fetch.ts

@@ -219,7 +219,7 @@ export function jsonFetch<T extends AnySchema>(
 
 export type JsonFetch = typeof jsonFetch;
 
-export function fromApi<TSchema extends AnySchema>(method: HttpMethod, url: string) {
+export function fromStaticRoute<TSchema extends AnySchema>(method: HttpMethod, url: string) {
   return function(
     args: RequestArgs<TSchema>,
     signal?: AbortSignal,
@@ -241,10 +241,10 @@ export function fromApi<TSchema extends AnySchema>(method: HttpMethod, url: stri
 }
 
 export function fromZodRoute<TSchema extends ZodRouteSchema>(method: HttpMethod, url: string) {
-  return fromApi<ZodRouteSchemaToSchema<TSchema>>(method, url);
+  return fromStaticRoute<ZodRouteSchemaToSchema<TSchema>>(method, url);
 }
 
 export function fromTypeboxRoute<TSchema extends TypeboxRouteSchema>(method: HttpMethod, url: string) {
-  return fromApi<TypeboxRouteSchemaToSchema<TSchema>>(method, url);
+  return fromStaticRoute<TypeboxRouteSchemaToSchema<TSchema>>(method, url);
 }
 

packages/runtime/src/route/index.ts

@@ -1,4 +1,4 @@
-export { createValidatorsFromSchema, route, Validator } from "./ajvRoute";
+export { createValidatorsFromStaticSchema, staticRoute as route, staticRoute, StaticValidator } from "./staticRoute";
 export { typeboxRoute, TypeboxRouteSchema, typeboxRouteSchema, TypeboxRouteSchemaToSchema } from "./typeboxRoute";
 export { zodRoute, zodRouteSchema } from "./zodRoute";
 export { Type } from "@sinclair/typebox";

packages/runtime/src/route/ajvRoute.ts renamed to packages/runtime/src/route/staticRoute.ts

@@ -8,7 +8,7 @@ import { ajvOptions, createAjv } from "./ajv";
 import { OrPromise, returnError, Serializer, ValueOf } from "./utils";
 
 
-export interface Validator {
+export interface StaticValidator {
   query?: ValidateFunction;
   body?: ValidateFunction;
   responseSerializers?: Map<string, Serializer>;
@@ -19,7 +19,7 @@ interface SchemaFileContent {
   routes: Record<string, SchemaObject>;
 }
 
-export function createValidatorsFromSchema(schemas: SchemaFileContent) {
+export function createValidatorsFromStaticSchema(schemas: SchemaFileContent) {
 
   const ajv = createAjv();
 
@@ -29,7 +29,7 @@ export function createValidatorsFromSchema(schemas: SchemaFileContent) {
   }
 
   // compile validatiors
-  const routeValiators = new Map<string, Validator>();
+  const routeValiators = new Map<string, StaticValidator>();
 
   for (const [name, schema] of Object.entries(schemas.routes)) {
     const query = schema.properties.query && ajv.compile(schema.properties.query);
@@ -58,11 +58,11 @@ export function createValidatorsFromSchema(schemas: SchemaFileContent) {
 }
 
 
-let validators: Map<string, Validator>;
+let validators: Map<string, StaticValidator>;
 
 
 
-export function route<S extends AnySchema>(
+export function staticRoute<S extends AnySchema>(
   schemaName: string,
   handler: (
     req: Omit<NextApiRequest, "body"> & {
@@ -75,7 +75,7 @@ export function route<S extends AnySchema>(
 
   if (!validators) {
     const schemas = JSON.parse(fs.readFileSync("./api-routes-schemas.json", "utf8"));
-    validators = createValidatorsFromSchema(schemas);
+    validators = createValidatorsFromStaticSchema(schemas);
   }
 
   const validator = validators.get(schemaName);

packages/runtime/tests/validators.test.ts

@@ -1,6 +1,6 @@
-import { createValidatorsFromSchema } from "../src/route/ajvRoute";
+import { createValidatorsFromStaticSchema } from "../src/route/staticRoute";
 import schemas from "./schemas.json";
 
 it("should correctly generate schemas", () => {
-  createValidatorsFromSchema(schemas);
+  createValidatorsFromStaticSchema(schemas);
 });