EntryRouter

File-based routing system that routes to file paths containing exported route handlers, enabling modular route organization and build-time optimization.

import EntryRouter from '@stackpress/ingest/plugin/EntryRouter';

const router = new EntryRouter(actionRouter, listen);

// Route to file exports
router.get('/users/:id', './routes/user.js');
router.post('/users', './routes/create-user.js');

// Event-based routing
router.on('user-created', './handlers/user-created.js');

Properties
HTTP Method Routing
Event-Based Routing
Creating Actions from Entries
Using Other EntryRouters
File Structure Requirements
Dynamic Import Process
Build Integration
Integration with ActionRouter
Best Practices

1. Properties

The following properties are available when instantiating an EntryRouter.

Property	Type	Description
`entries`	`Map<string, Set<EntryRouterTaskItem>>`	Map of event names to entry file configurations (readonly)

2. HTTP Method Routing

The following examples show how to define file-based routes for different HTTP methods.

// GET routes
router.get('/users', './routes/users/list.js');
router.get('/users/:id', './routes/users/get.js');

// POST routes
router.post('/users', './routes/users/create.js');

// PUT routes
router.put('/users/:id', './routes/users/update.js');

// DELETE routes
router.delete('/users/:id', './routes/users/delete.js');

// Handle any method
router.all('/health', './routes/health.js');

Parameters

Parameter	Type	Description
`path`	`string`	Route path with optional parameters (:id)
`action`	`string`	File path to the route handler
`priority`	`number`	Priority level (default: 0)

Returns

The EntryRouter instance to allow method chaining.

3. Event-Based Routing

The following example shows how to route events to file handlers.

// Route custom events to files
router.on('user-login', './handlers/user-login.js');
router.on('data-updated', './handlers/data-updated.js');

// Route with regex patterns
router.on(/^email-.+$/, './handlers/email-handler.js');

Parameters

Parameter	Type	Description
`event`	`string\|RegExp`	Event name or pattern
`entry`	`string`	File path to the event handler
`priority`	`number`	Priority level (default: 0)

Returns

The EntryRouter instance to allow method chaining.

4. Creating Actions from Entries

The following example shows how entry files are converted to executable actions.

// Internal method - creates action from file path
const action = router.action('GET /users', './routes/users.js', 0);

// The action dynamically imports and executes the file
await action(request, response, context);

Parameters

Parameter	Type	Description
`event`	`string`	Event name for tracking
`action`	`string`	File path to import
`priority`	`number`	Priority level (default: 0)

Returns

An async function that imports and executes the file's default export.

5. Using Other EntryRouters

The following example shows how to merge entries from another router.

const apiRouter = new EntryRouter(actionRouter, listen);
apiRouter.get('/api/users', './api/users.js');

const mainRouter = new EntryRouter(actionRouter, listen);
mainRouter.use(apiRouter); // Merges entry configurations

Parameters

Parameter	Type	Description
`router`	`EntryRouter<R, S, X>`	Another EntryRouter to merge entries from

Returns

The EntryRouter instance to allow method chaining.

6. File Structure Requirements

Entry files must export a default function that matches the route handler signature.

6.1. Basic Route Handler

The following example shows a basic route handler file structure.

// ./routes/users/list.js
export default async function(req, res, ctx) {
  const users = await getUsers();
  res.setResults(users);
}

6.2. Route Handler with Parameters

The following example shows how to handle route parameters in entry files.

// ./routes/users/get.js
export default async function(req, res, ctx) {
  const id = req.data.get('id'); // Route parameter
  const user = await getUser(id);
  
  if (!user) {
    res.setError('User not found', {}, [], 404);
    return false;
  }
  
  res.setResults(user);
  return true;
}

6.3. Event Handler

The following example shows how to structure event handler files.

// ./handlers/user-login.js
export default async function(req, res, ctx) {
  const user = req.data.get('user');
  
  // Log the login
  await logUserLogin(user.id);
  
  // Send welcome email
  await sendWelcomeEmail(user.email);
  
  return true; // Continue processing
}

6.4. Complex Route Handler

The following example shows a complex route handler with validation and error handling.

// ./routes/users/create.js
import { validateUser } from '../validators/user.js';
import { createUser } from '../services/user.js';

export default async function(req, res, ctx) {
  try {
    const userData = req.data.get();
    
    // Validate input
    const validation = await validateUser(userData);
    if (!validation.valid) {
      res.setError('Validation failed', validation.errors, [], 400);
      return false;
    }
    
    // Create user
    const user = await createUser(userData);
    
    // Emit user created event
    await ctx.emit('user-created', req, res);
    
    res.setResults(user, 201);
    return true;
  } catch (error) {
    res.setError('Failed to create user', {}, [], 500);
    return false;
  }
}

7. Dynamic Import Process

EntryRouter uses dynamic imports to load route handlers at runtime.

7.1. Import Flow

The following steps describe how EntryRouter processes file imports:

Route Registration: File path is registered with the route
Request Handling: When route is matched, dynamic import is triggered
Module Loading: File is imported using import() statement
Default Export: The default export is extracted and executed
Execution: Handler is called with request, response, and context

7.2. Import Example

The following example shows the internal implementation of dynamic imports.

// Internal implementation
async function EntryFileAction(req, res, ctx) {
  // Dynamic import of the route file
  const imports = await import('./routes/user.js');
  
  // Extract default export
  const callback = imports.default;
  
  // Execute the handler
  return await callback(req, res, ctx);
}

8. Build Integration

EntryRouter provides build-time information for bundlers and static analysis.

8.1. Entry Tracking

The following example shows how to access entry configurations for build tools.

// Access entry configurations
console.log(router.entries);
// Map {
//   'GET /users' => Set([{ entry: './routes/users.js', priority: 0 }]),
//   'POST /users' => Set([{ entry: './routes/create.js', priority: 0 }])
// }

8.2. Bundle Optimization

The following example shows how bundlers can optimize EntryRouter configurations.

// Bundlers can analyze entry configurations to:
// 1. Pre-compile route files
// 2. Generate static route tables
// 3. Optimize code splitting
// 4. Create dependency graphs

const entries = Array.from(router.entries.values())
  .flatMap(set => Array.from(set))
  .map(item => item.entry);

console.log('Route files to bundle:', entries);

9. Integration with ActionRouter

EntryRouter works as an extension of ActionRouter, sharing the same event system and routing capabilities.

9.1. Initialization

The following example shows how EntryRouter integrates with ActionRouter.

import ActionRouter from '@stackpress/ingest/plugin/ActionRouter';

const actionRouter = new ActionRouter(context);

// EntryRouter is automatically available
actionRouter.entry.get('/users', './routes/users.js');

// Or create standalone
const entryRouter = new EntryRouter(actionRouter, listen);

9.2. Shared Event System

The following example shows how both routers share the same event system.

// Both routers share the same event system
actionRouter.get('/api', handlerFunction);
actionRouter.entry.get('/files', './routes/files.js');

// Both routes are available in the same router
await actionRouter.emit('GET /api', req, res);
await actionRouter.emit('GET /files', req, res);

10. Best Practices

The following guidelines help ensure effective use of EntryRouter in production applications.

10.1. File Organization

The following examples show recommended file organization patterns.

// Organize by feature
router.get('/users', './routes/users/index.js');
router.get('/users/:id', './routes/users/get.js');
router.post('/users', './routes/users/create.js');
router.put('/users/:id', './routes/users/update.js');
router.delete('/users/:id', './routes/users/delete.js');

// Organize by HTTP method
router.get('/posts', './routes/get/posts.js');
router.post('/posts', './routes/post/posts.js');
router.put('/posts/:id', './routes/put/posts.js');

10.2. Error Handling

The following example shows proper error handling in entry files.

// ./routes/error-example.js
export default async function(req, res, ctx) {
  try {
    const result = await riskyOperation();
    res.setResults(result);
    return true;
  } catch (error) {
    // Log error
    console.error('Route error:', error);
    
    // Set appropriate error response
    if (error.code === 'VALIDATION_ERROR') {
      res.setError('Invalid input', error.details, [], 400);
    } else {
      res.setError('Internal server error', {}, [], 500);
    }
    
    return false; // Abort processing
  }
}

10.3. Shared Utilities

The following example shows how to share utilities across entry files.

// ./routes/shared/auth.js
export async function requireAuth(req, res) {
  const token = req.headers.get('authorization');
  if (!token) {
    res.setError('Unauthorized', {}, [], 401);
    return null;
  }
  
  return await validateToken(token);
}

// ./routes/users/protected.js
import { requireAuth } from '../shared/auth.js';

export default async function(req, res, ctx) {
  const user = await requireAuth(req, res);
  if (!user) return false; // Auth failed
  
  // Continue with protected logic
  res.setResults({ user });
  return true;
}

10.4. Development vs Production

The following example shows how to handle different environments with EntryRouter.

// Use different files for different environments
const isDev = process.env.NODE_ENV === 'development';

router.get('/debug', isDev 
  ? './routes/debug/full.js' 
  : './routes/debug/minimal.js'
);

// Conditional route registration
if (isDev) {
  router.get('/dev-tools', './routes/dev/tools.js');
}

10.5. Type Safety

The following example shows how to implement type safety in entry files.

// ./routes/typed-example.ts
import type { Request, Response, Server } from '@stackpress/ingest';

interface UserData {
  name: string;
  email: string;
}

export default async function(
  req: Request<any>, 
  res: Response<any>, 
  ctx: Server<any, any, any>
) {
  const userData = req.data.get() as UserData;
  
  // Type-safe operations
  const user = await createUser(userData);
  res.setResults(user);
  
  return true;
}

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

EntryRouter

Table of Contents

1. Properties

2. HTTP Method Routing

3. Event-Based Routing

4. Creating Actions from Entries

5. Using Other EntryRouters

6. File Structure Requirements

6.1. Basic Route Handler

6.2. Route Handler with Parameters

6.3. Event Handler

6.4. Complex Route Handler

7. Dynamic Import Process

7.1. Import Flow

7.2. Import Example

8. Build Integration

8.1. Entry Tracking

8.2. Bundle Optimization

9. Integration with ActionRouter

9.1. Initialization

9.2. Shared Event System

10. Best Practices

10.1. File Organization

10.2. Error Handling

10.3. Shared Utilities

10.4. Development vs Production

10.5. Type Safety

FilesExpand file tree

EntryRouter.md

Latest commit

History

EntryRouter.md

File metadata and controls

EntryRouter

Table of Contents

1. Properties

2. HTTP Method Routing

3. Event-Based Routing

4. Creating Actions from Entries

5. Using Other EntryRouters

6. File Structure Requirements

6.1. Basic Route Handler

6.2. Route Handler with Parameters

6.3. Event Handler

6.4. Complex Route Handler

7. Dynamic Import Process

7.1. Import Flow

7.2. Import Example

8. Build Integration

8.1. Entry Tracking

8.2. Bundle Optimization

9. Integration with ActionRouter

9.1. Initialization

9.2. Shared Event System

10. Best Practices

10.1. File Organization

10.2. Error Handling

10.3. Shared Utilities

10.4. Development vs Production

10.5. Type Safety