@alexmc2/create-express-api-starter 0.1.3 → 0.1.5

package/templates/ts/simple/src/app.ts.ejs

@@ -1,45 +0,0 @@
-<% if (educational) { %>// File overview: Builds and configures the Express app (middleware, routes, and error pipeline).
-<% } %>
-import cors from 'cors';
-import express from 'express';
-import helmet from 'helmet';
-import morgan from 'morgan';
-
-import errorHandler from './middleware/errorHandler';
-import notFound from './middleware/notFound';
-import healthRouter from './routes/health';
-import usersRouter from './routes/users';
-
-const app = express();
-
-<% if (educational) { %>// Parse JSON request bodies so route handlers can read data from req.body.
-// Without this middleware, req.body is undefined for JSON requests.
-<% } %>app.use(express.json());
-<% if (educational) { %>// Enable CORS so browser clients on other origins can call this API.
-<% } %>app.use(cors());
-<% if (educational) { %>// Add common HTTP security headers.
-// Helmet applies safe defaults that reduce exposure to common web attacks.
-<% } %>app.use(helmet());
-<% if (educational) { %>// Log each request in development format to make local debugging easier.
-<% } %>app.use(morgan('dev'));
-
-<% if (educational) { %>// Provide a simple root endpoint so visiting the API URL in a browser
-// shows available routes instead of an immediate 404 response.
-<% } %>app.get('/', (_req, res) => {
-  res.json({
-    message: 'API is running',
-    endpoints: {
-      health: 'GET /health',
-      users: 'GET /api/users',
-      createUser: 'POST /api/users'
-    }
-  });
-});
-
-app.use('/health', healthRouter);
-app.use('/api/users', usersRouter);
-
-app.use(notFound);
-app.use(errorHandler);
-
-export default app;

package/templates/ts/simple/src/db/pool.ts.ejs

@@ -1,17 +0,0 @@
-<% if (educational) { %>// File overview: Creates and exports a shared PostgreSQL connection pool for repository queries.
-<% } %>
-<% if (educational) { %>// Create one shared connection pool for the whole application.
-// Reusing connections is faster and avoids exhausting database limits.
-<% } %>import { Pool } from 'pg';
-
-const databaseUrl = process.env.DATABASE_URL;
-
-if (!databaseUrl) {
-  throw new Error('DATABASE_URL is required for Postgres mode.');
-}
-
-const pool = new Pool({
-  connectionString: databaseUrl
-});
-
-export default pool;

package/templates/ts/simple/src/errors/AppError.ts.ejs

@@ -1,14 +0,0 @@
-<% if (educational) { %>// File overview: Defines an AppError class for expected API errors that include HTTP status codes.
-<% } %>
-<% if (educational) { %>// A custom error class for handling API errors. By extending JavaScript's
-// built-in Error class, we ensure that stack traces are generated correctly
-// and that the error handler can distinguish between anticipated API
-// errors and unexpected application failures.
-<% } %>export default class AppError extends Error {
-  status: number;
-
-  constructor(status: number, message: string) {
-    super(message);
-    this.status = status;
-  }
-}

package/templates/ts/simple/src/middleware/errorHandler.ts.ejs

@@ -1,49 +0,0 @@
-<% if (educational) { %>// File overview: Converts thrown errors into consistent JSON HTTP responses for clients.
-<% } %>
-import type { ErrorRequestHandler } from 'express';
-
-interface HttpError extends Error {
-  status?: number;
-  code?: string;
-  detail?: string;
-}
-
-<% if (educational) { %>// Express treats middleware with four parameters as an error handler.
-// Any error passed to next(error) in the app is routed to this function.
-<% } %>const errorHandler: ErrorRequestHandler = (error: HttpError, _req, res, _next) => {
-<% if (educational) { %>  // PostgreSQL error code 23505 means a UNIQUE constraint was violated.
-  // Returning HTTP 409 tells clients that the request conflicts with existing data.
-<% } %>  if (error?.code === '23505') {
-    const detail = typeof error?.detail === 'string' ? error.detail : '';
-    const message = detail.includes('email')
-      ? 'A user with this email already exists.'
-      : 'A record with this value already exists.';
-
-    return res.status(409).json({
-      status: 409,
-      message
-    });
-  }
-
-  const status = Number.isInteger(error?.status) ? (error.status as number) : 500;
-  const message = typeof error?.message === 'string' ? error.message : 'Internal server error.';
-
-  const payload: {
-    status: number;
-    message: string;
-    stack?: string;
-  } = {
-    status,
-    message
-  };
-
-<% if (educational) { %>  // Include stack traces in development to speed up debugging.
-  // Omit them in production so internal implementation details stay private.
-<% } %>  if (process.env.NODE_ENV === 'development' && typeof error?.stack === 'string') {
-    payload.stack = error.stack;
-  }
-
-  res.status(status).json(payload);
-};
-
-export default errorHandler;

package/templates/ts/simple/src/middleware/notFound.ts.ejs

@@ -1,13 +0,0 @@
-<% if (educational) { %>// File overview: Handles unmatched routes by forwarding a 404 error to the central error handler.
-<% } %>
-import type { RequestHandler } from 'express';
-
-import AppError from '../errors/AppError';
-
-<% if (educational) { %>// This middleware runs only when no route matched the request.
-// It forwards a 404 error to the central error handler for a uniform response.
-<% } %>const notFound: RequestHandler = (_req, _res, next) => {
-  next(new AppError(404, 'Route not found.'));
-};
-
-export default notFound;

package/templates/ts/simple/src/routes/health.ts.ejs

@@ -1,13 +0,0 @@
-<% if (educational) { %>// File overview: Registers the health-check route used to confirm the API process is running.
-<% } %>
-import { Router } from 'express';
-
-const router = Router();
-
-<% if (educational) { %>// Health-check endpoint used by monitors, load balancers, and container
-// platforms to verify that the API process is running.
-<% } %>router.get('/', (_req, res) => {
-  res.status(200).json({ ok: true });
-});
-
-export default router;

package/templates/ts/simple/src/server.ts.ejs

@@ -1,15 +0,0 @@
-<% if (educational) { %>// File overview: Application entry point that loads environment variables and starts the HTTP server.
-<% } %>
-<% if (educational) { %>// Load variables from .env before other modules read process.env values.
-<% } %>import 'dotenv/config';
-
-import app from './app';
-import { getPort } from './utils/getPort';
-
-<% if (educational) { %>// Read the server port from PORT, defaulting to 3000 for local development.
-<% } %>const port = getPort(process.env.PORT, 3000);
-
-<% if (educational) { %>// Start the HTTP server and listen for incoming requests.
-<% } %>app.listen(port, () => {
-  console.log(`Server listening on port ${port}`);
-});

package/templates/ts/simple/src/utils/getPort.ts.ejs

@@ -1,12 +0,0 @@
-<% if (educational) { %>// File overview: Parses PORT into a usable integer with a safe fallback.
-<% } %>
-<% if (educational) { %>// Keep this helper small and pure so entrypoint code stays easy to scan.
-<% } %>export function getPort(value: string | undefined, fallback = 3000): number {
-  const parsed = Number(value);
-
-  if (Number.isInteger(parsed) && parsed > 0) {
-    return parsed;
-  }
-
-  return fallback;
-}

package/templates/ts/simple/tsconfig.json.ejs

@@ -1,13 +0,0 @@
-{
-  "compilerOptions": {
-    "module": "node16",
-    "moduleResolution": "node16",
-    "outDir": "./dist",
-    "rootDir": "./src",
-    "esModuleInterop": true,
-    "strict": true,
-    "target": "ES2022",
-    "skipLibCheck": true
-  },
-  "include": ["src"]
-}