chore(routing): reorganize routing internals (#148)

chore: reorganize routing internals

Author: imdhemy

src/Config/types.ts

@@ -1,7 +1,7 @@
 import { type HttpMiddleware } from '@/Http';
 import { type StaticFilesOptions } from '@/Http/Files';
 import { type EventSubscriber } from '@/Kernel';
-import type { RouteSource } from '@/routing/route-source';
+import type { RouteSource } from '@/routing';
 
 /**
  * @deprecated Use function-first routes from `@koala-ts/framework/routing` with `KoalaConfig.routes` instead.

src/application/create-application.ts

@@ -5,7 +5,7 @@ import { applyConfiguredGlobalMiddleware } from '@/Http/middleware/apply-configu
 import { initializeRequestScopeStorage } from '@/Http/Scope/request-scope-storage';
 import { registerEventSubscribers } from '@/Kernel';
 import { registerLegacyRoutes } from '@/routing/decorator/legacy-router';
-import { registerRoutes } from '@/routing/register-routes';
+import { registerRoutes } from '@/routing/registration/register-routes';
 import { verifyRoutingMode } from '@/routing/verify-routing-mode';
 import Koa from 'koa';
 import { type Application } from './application';

src/routing/create-route-definition.test.ts

@@ -1,9 +1,9 @@
 import { type Application } from '@/application/application';
-import { registerRoutes } from '@/routing/register-routes';
-import 'reflect-metadata';
 import { type HttpMiddleware } from '@/Http';
-import { createRouteDefinition } from '@/routing/create-route-definition';
-import type { RouteDefinition } from '@/routing/route-definition';
+import { createRouteDefinition } from '@/routing/definition/create-route-definition';
+import type { RouteDefinition } from '@/routing/definition/route-definition';
+import { registerRoutes } from '@/routing/registration/register-routes';
+import 'reflect-metadata';
 import type { Route } from './route';
 import type { RouteMetadata } from './route-metadata';
 

src/routing/decorator/legacy-router.ts

@@ -0,0 +1,100 @@
+import { describe, expect, test, vi } from 'vitest';
+import { createRouteDefinition } from './create-route-definition';
+
+describe('create route definition', () => {
+  test('it creates a route definition for a single method', () => {
+    const handler = vi.fn(async () => undefined);
+
+    const route = createRouteDefinition({
+      method: 'GET',
+      path: '/users',
+      handler,
+    });
+
+    expect(route).toEqual({
+      path: '/users',
+      methods: ['get'],
+      handler,
+      middleware: [],
+      parseBody: true,
+      bodyOptions: {},
+    });
+  });
+
+  test('it creates a route definition with name middleware and body options', () => {
+    const handler = vi.fn(async () => undefined);
+    const middleware = [vi.fn(async () => undefined)];
+
+    const route = createRouteDefinition({
+      name: 'users.create',
+      method: 'POST',
+      path: '/users',
+      handler,
+      middleware,
+      options: {
+        multipart: true,
+        parseBody: false,
+      },
+    });
+
+    expect(route).toEqual({
+      name: 'users.create',
+      path: '/users',
+      methods: ['post'],
+      handler,
+      middleware,
+      parseBody: false,
+      bodyOptions: {
+        multipart: true,
+      },
+    });
+  });
+
+  test('it qualifies multiple methods', () => {
+    const handler = vi.fn(async () => undefined);
+
+    const route = createRouteDefinition({
+      method: ['GET', 'POST'],
+      path: '/users',
+      handler,
+    });
+
+    expect(route.methods).toEqual(['get', 'post']);
+  });
+
+  test('it normalizes any and all to all', () => {
+    const handler = vi.fn(async () => undefined);
+
+    const route = createRouteDefinition({
+      method: ['ANY', 'ALL'],
+      path: '/users',
+      handler,
+    });
+
+    expect(route.methods).toEqual(['all']);
+  });
+
+  test('it normalizes any with specific methods to all', () => {
+    const handler = vi.fn(async () => undefined);
+
+    const route = createRouteDefinition({
+      method: ['ANY', 'GET'],
+      path: '/users',
+      handler,
+    });
+
+    expect(route.methods).toEqual(['all']);
+  });
+
+  test('it removes duplicate specific methods case-insensitively', () => {
+    const handler = vi.fn(async () => undefined);
+
+    const route = createRouteDefinition({
+      method: ['GET', 'get', 'POST'],
+      path: '/users',
+      handler,
+    });
+
+    expect(route.methods).toEqual(['get', 'post']);
+  });
+});

src/routing/definition/create-route-definition.test.ts

@@ -1,7 +1,7 @@
 import type { HttpMiddleware } from '@/Http';
 import type { HttpMethod } from '@/routing/http-method';
 import type { RouteOptions } from '@/routing/route-options';
-import { resolveRouteOptions } from '@/routing/resolve-route-options';
+import { resolveRouteOptions } from '@/routing/definition/resolve-route-options';
 import type { RouterMethod } from '@/routing/router-method';
 import type { RouteDefinition } from './route-definition';
 

src/routing/create-route-definition.ts …ng/definition/create-route-definition.tssrc/routing/create-route-definition.ts renamed to src/routing/definition/create-route-definition.ts src/routing/create-route-definition.ts renamed to src/routing/definition/create-route-definition.ts

@@ -1,5 +1,5 @@
-import type { RouteDefinition } from '@/routing/route-definition';
 import type { RouteOptions } from '@/routing/route-options';
+import type { RouteDefinition } from './route-definition';
 
 export function resolveRouteOptions(options: RouteOptions): Pick<RouteDefinition, 'parseBody' | 'bodyOptions'> {
   return {

src/routing/resolve-route-options.test.ts …definition/resolve-route-options.test.tssrc/routing/resolve-route-options.test.ts renamed to src/routing/definition/resolve-route-options.test.ts src/routing/resolve-route-options.test.ts renamed to src/routing/definition/resolve-route-options.test.ts

@@ -1,6 +1,6 @@
 import type { HttpMiddleware } from '@/Http';
-import type { KoaBodyMiddlewareOptions } from 'koa-body';
 import type { RouterMethod } from '@/routing/router-method';
+import type { KoaBodyMiddlewareOptions } from 'koa-body';
 
 export interface RouteDefinition {
   name?: string;