adorn-api 1.0.22 → 1.0.24

package/examples/utils/start-server.ts

@@ -0,0 +1,56 @@
+import type { Application } from "express";
+import type { Server } from "http";
+
+const DEFAULT_PORT = 3000;
+
+export interface StartServerOptions {
+  /**
+   * Friendly name for the running example to include in the log message.
+   */
+  name: string;
+  /**
+   * Port to listen on when `PORT` is not set in the environment.
+   */
+  port?: number;
+  /**
+   * Additional log lines to emit once the server is listening.
+   */
+  extraLogs?: Array<(port: number) => string>;
+}
+
+export function startExampleServer(app: Application, options: StartServerOptions): void {
+  const envPort = Number(process.env.PORT);
+  const port = Number.isInteger(envPort) && envPort > 0 ? envPort : (options.port ?? DEFAULT_PORT);
+
+  let server: Server | undefined;
+  try {
+    server = app.listen(port, () => {
+      console.log(`${options.name} running on http://localhost:${port}`);
+      for (const log of options.extraLogs ?? []) {
+        console.log(log(port));
+      }
+    });
+  } catch (error) {
+    handleListenError(error, port);
+    return;
+  }
+
+  if (!server) {
+    return;
+  }
+
+  server.on("error", (error) => {
+    handleListenError(error, port);
+  });
+}
+
+function handleListenError(error: unknown, port: number): never {
+  const err = error as NodeJS.ErrnoException | undefined;
+  if (err?.code === "EADDRINUSE") {
+    console.error(
+      `Port ${port} is already in use. Please stop the process listening on it (e.g. "npx kill-port ${port}", "taskkill /F /PID <pid>" on Windows, or "kill <pid>" on Unix) and try again.`
+    );
+    process.exit(1);
+  }
+  throw err ?? error;
+}

package/package.json

@@ -1,97 +1,33 @@
-{
-  "name": "adorn-api",
-  "version": "1.0.22",
-  "description": "Stage-3 decorator-first OpenAPI + routing toolkit",
-  "license": "MIT",
-  "type": "module",
-  "engines": {
-    "node": ">=18"
-  },
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs"
-    },
-    "./express": {
-      "types": "./dist/express.d.ts",
-      "import": "./dist/express.js",
-      "require": "./dist/express.cjs"
-    },
-    "./cli": {
-      "types": "./dist/cli.d.ts",
-      "import": "./dist/cli.js",
-      "require": "./dist/cli.cjs"
-    },
-    "./schema": {
-      "types": "./dist/schema/index.d.ts",
-      "import": "./dist/schema/index.js",
-      "require": "./dist/schema/index.cjs"
-    },
-    "./metal": {
-      "types": "./dist/metal/index.d.ts",
-      "import": "./dist/metal/index.js",
-      "require": "./dist/metal/index.cjs"
-    },
-    "./package.json": "./package.json"
-  },
-  "bin": {
-    "adorn-api": "./dist/cli.cjs",
-    "adorn-example": "./dist/scripts/adorn-example.cjs"
-  },
-  "files": [
-    "dist",
-    "templates"
-  ],
-  "scripts": {
-    "clean": "rimraf dist",
-    "typecheck": "tsc -p tsconfig.json",
-    "lint": "eslint src --ext .ts",
-    "check": "npm run typecheck && npm run test",
-    "build:js": "tsup src/index.ts src/express.ts src/cli.ts src/schema/index.ts src/metal/index.ts --format esm,cjs --out-dir dist --sourcemap --no-splitting && tsup scripts/adorn-example.ts --format cjs --out-dir dist/scripts --sourcemap --no-splitting",
-    "build:types": "tsc -p tsconfig.build.json",
-    "build": "npm run clean && npm run build:js && npm run build:types",
-    "test": "vitest run",
-    "test:staleness": "vitest run test/cache/staleness.test.ts",
-    "dev": "tsx src/cli.ts dev",
-    "example": "tsx scripts/run-example.ts",
-    "example:list": "tsx scripts/adorn-example.ts --list",
-    "example:blog-platform": "npm run example -- blog-platform",
-    "example:task-manager": "npm run example -- task-manager",
-    "example:basic": "npm run example -- basic",
-    "examples:install": "cd examples/basic && npm install"
-  },
-  "dependencies": {
-    "ajv": "^8.17.1",
-    "ajv-formats": "^3.0.1",
-    "cors": "^2.8.5",
-    "metal-orm": "^1.0.80",
-    "swagger-ui-express": "^5.0.0",
-    "typescript": "^5.9.0"
-  },
-  "peerDependencies": {
-    "express": "^4.18.0 || ^5.0.0"
-  },
-  "peerDependenciesMeta": {
-    "express": {
-      "optional": true
-    }
-  },
-  "devDependencies": {
-    "@eslint/js": "^9.39.2",
-    "@types/cors": "^2.8.17",
-    "@types/express": "^4.17.0",
-    "@types/node": "^20.0.0",
-    "@types/supertest": "^6.0.0",
-    "@types/swagger-ui-express": "^4.1.6",
-    "@typescript-eslint/eslint-plugin": "^8.52.0",
-    "@typescript-eslint/parser": "^8.52.0",
-    "eslint": "^9.39.2",
-    "express": "^5.2.1",
-    "rimraf": "^6.0.0",
-    "supertest": "^7.1.4",
-    "tsup": "^8.0.0",
-    "tsx": "^4.0.0",
-    "vitest": "^2.0.0"
-  }
-}
+{
+  "name": "adorn-api",
+  "version": "1.0.24",
+  "description": "Decorator-first web framework with OpenAPI 3.1 schema generation.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "dev": "tsx examples/basic/index.ts",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "example": "node scripts/run-example.js",
+    "check": "tsc -p tsconfig.json --noEmit && npm test",
+    "lint": "eslint . --ext .ts,.tsx,.js"
+  },
+  "dependencies": {
+    "express": "^4.19.2",
+    "metal-orm": "^1.0.91"
+  },
+  "devDependencies": {
+    "@types/express": "^4.17.21",
+    "@types/sqlite3": "^3.1.11",
+    "@types/supertest": "^2.0.16",
+    "@typescript-eslint/eslint-plugin": "^8.53.0",
+    "@typescript-eslint/parser": "^8.53.0",
+    "eslint": "^8.57.1",
+    "sqlite3": "^5.1.7",
+    "supertest": "^6.3.4",
+    "tsx": "^4.7.0",
+    "typescript": "^5.4.5",
+    "vitest": "^2.0.5"
+  }
+}

package/scripts/run-example.js

@@ -0,0 +1,29 @@
+/* eslint-disable @typescript-eslint/no-require-imports */
+
+const { spawnSync } = require("child_process");
+const { existsSync, readdirSync, statSync } = require("fs");
+const { resolve } = require("path");
+
+const examplesDir = resolve(__dirname, "..", "examples");
+const exampleName = process.argv[2] || "basic";
+const entry = resolve(examplesDir, exampleName, "index.ts");
+
+if (!existsSync(entry)) {
+  const examples = readdirSync(examplesDir)
+    .filter((name) => statSync(resolve(examplesDir, name)).isDirectory())
+    .sort();
+  console.error(`Example "${exampleName}" not found.`);
+  console.error(`Available examples: ${examples.join(", ") || "none"}`);
+  process.exit(1);
+}
+
+const tsxCommand = "tsx";
+const result = spawnSync(tsxCommand, [entry], {
+  stdio: "inherit",
+  shell: process.platform === "win32"
+});
+if (result.error) {
+  console.error(result.error.message);
+  process.exit(1);
+}
+process.exit(result.status ?? 1);