transit-kit 0.8.2 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -49,8 +49,6 @@ import { z } from "zod";
|
|
|
49
49
|
// Create a server
|
|
50
50
|
const server = createServer({
|
|
51
51
|
port: 3000,
|
|
52
|
-
inDevMode: true,
|
|
53
|
-
logger: true,
|
|
54
52
|
});
|
|
55
53
|
|
|
56
54
|
// Define a simple endpoint
|
|
@@ -168,8 +166,6 @@ import { z } from "zod";
|
|
|
168
166
|
|
|
169
167
|
const server = createServer({
|
|
170
168
|
port: 3000,
|
|
171
|
-
inDevMode: true,
|
|
172
|
-
logger: true,
|
|
173
169
|
});
|
|
174
170
|
|
|
175
171
|
// In-memory storage (use a real database in production)
|
|
@@ -566,8 +562,6 @@ Creates a new Transit-Kit server instance.
|
|
|
566
562
|
|
|
567
563
|
**Config Options:**
|
|
568
564
|
- `port: number` — Port to listen on
|
|
569
|
-
- `inDevMode: boolean` — Enable development mode (detailed logging)
|
|
570
|
-
- `logger: Logger | boolean` — Custom logger or true/false for console/no logging
|
|
571
565
|
|
|
572
566
|
**Returns:** Server instance with:
|
|
573
567
|
- `expressApp: Application` — Underlying Express app
|
package/dist/server/server.d.ts
CHANGED
|
@@ -1,15 +1,11 @@
|
|
|
1
1
|
import { Application } from "express";
|
|
2
2
|
import { ApiEndpointDefinition } from "./handlers/api/EndpointDefinition.js";
|
|
3
3
|
import { HandlerForDefinition } from "./handlers/api/HandlerFromDefinition.js";
|
|
4
|
-
import { Logger } from "./utils/logging.js";
|
|
5
4
|
export interface ServerConfig {
|
|
6
|
-
inDevMode: boolean;
|
|
7
5
|
port: number;
|
|
8
|
-
logger: Logger | boolean;
|
|
9
6
|
}
|
|
10
7
|
export interface Server {
|
|
11
8
|
expressApp: Application;
|
|
12
|
-
logger: Logger | boolean;
|
|
13
9
|
endpointDefinitions: ApiEndpointDefinition[];
|
|
14
10
|
registerApiEndpoint<Definition extends ApiEndpointDefinition>({ definition, handler, }: {
|
|
15
11
|
definition: Definition;
|
package/dist/server/server.js
CHANGED
|
@@ -2,11 +2,10 @@ import cookieParser from "cookie-parser";
|
|
|
2
2
|
import express from "express";
|
|
3
3
|
import { buildApiEndpointHandler } from "./handlers/api/createApiHandler.js";
|
|
4
4
|
import { buildAuthenticationMiddleware } from "./middleware/auth.js";
|
|
5
|
-
import { buildRequestLogger, buildResponseLogger, } from "./middleware/logging.js";
|
|
6
5
|
import { buildBodyValidatorMiddleware, buildQueryValidatorMiddleware, } from "./middleware/validation.js";
|
|
7
6
|
import { isEmpty } from "./utils/funcs.js";
|
|
8
|
-
import {
|
|
9
|
-
import
|
|
7
|
+
import { hasValue } from "./utils/typeGuards.js";
|
|
8
|
+
import colors from "colors";
|
|
10
9
|
function registerApiEndpoint(expressApp, endpoint) {
|
|
11
10
|
const { definition, handler } = endpoint;
|
|
12
11
|
const handlerStack = [
|
|
@@ -24,28 +23,31 @@ function registerApiEndpoint(expressApp, endpoint) {
|
|
|
24
23
|
expressApp[definition.method](definition.path, handlerStack);
|
|
25
24
|
}
|
|
26
25
|
export function createServer(config) {
|
|
27
|
-
const { port
|
|
28
|
-
const logger = config.logger === true
|
|
29
|
-
? console
|
|
30
|
-
: config.logger === false || hasNoValue(config.logger)
|
|
31
|
-
? NoOpLogger
|
|
32
|
-
: config.logger;
|
|
26
|
+
const { port } = config;
|
|
33
27
|
const app = express();
|
|
34
28
|
app.use(express.json());
|
|
35
29
|
app.use(express.urlencoded({ extended: true }));
|
|
36
30
|
app.use(cookieParser());
|
|
37
|
-
app.use(buildRequestLogger(logger, inDevMode));
|
|
38
|
-
app.use(buildResponseLogger(logger, inDevMode));
|
|
39
31
|
return {
|
|
40
32
|
expressApp: app,
|
|
41
|
-
logger: logger,
|
|
42
33
|
endpointDefinitions: [],
|
|
43
34
|
registerApiEndpoint(endpoint) {
|
|
44
35
|
registerApiEndpoint(app, endpoint);
|
|
45
36
|
this.endpointDefinitions.push(endpoint.definition);
|
|
46
37
|
},
|
|
47
38
|
start() {
|
|
48
|
-
app.listen(port)
|
|
39
|
+
app.listen(port, (err) => {
|
|
40
|
+
if (hasValue(err)) {
|
|
41
|
+
console.error(`${colors.red("Failed")} to start server on ${colors.cyan(port.toString())}`, err);
|
|
42
|
+
}
|
|
43
|
+
else {
|
|
44
|
+
console.log(`${colors.green("Successfully")} started server on ${colors.cyan(port.toString())}`);
|
|
45
|
+
this.endpointDefinitions.forEach((definition) => {
|
|
46
|
+
console.log(`Registering endpoint handler on ${colors.cyan(definition.path)} - ${colors.magenta(definition.method)}`);
|
|
47
|
+
});
|
|
48
|
+
console.log();
|
|
49
|
+
}
|
|
50
|
+
});
|
|
49
51
|
},
|
|
50
52
|
};
|
|
51
53
|
}
|
package/package.json
CHANGED
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
import { NextFunction, Request, Response } from "express";
|
|
2
|
-
import { Logger } from "../utils/logging.js";
|
|
3
|
-
export declare function buildRequestLogger(logger: Logger, isInDevMode: boolean): (req: Request, res: Response, next: NextFunction) => void;
|
|
4
|
-
export declare function buildResponseLogger(logger: Logger, isInDevMode: boolean): (req: Request, res: Response, next: NextFunction) => void;
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
import colors from "colors/safe.js";
|
|
2
|
-
export function buildRequestLogger(logger, isInDevMode) {
|
|
3
|
-
return (req, res, next) => {
|
|
4
|
-
logger.info(`[Request] ${colors.cyan(req.method)} - ${colors.cyan(req.path)}`);
|
|
5
|
-
if (isInDevMode) {
|
|
6
|
-
logger.info(`[Request - Dev] Headers: ${JSON.stringify(req.headers)}`);
|
|
7
|
-
logger.info(`[Request - Dev] Query: ${JSON.stringify(req.query)}`);
|
|
8
|
-
logger.info(`[Request - Dev] Body: ${JSON.stringify(req.body)}`);
|
|
9
|
-
}
|
|
10
|
-
next();
|
|
11
|
-
};
|
|
12
|
-
}
|
|
13
|
-
export function buildResponseLogger(logger, isInDevMode) {
|
|
14
|
-
return (req, res, next) => {
|
|
15
|
-
const originalSend = res.send;
|
|
16
|
-
res.send = function (body) {
|
|
17
|
-
logger.info(`[Response] ${colors.cyan(req.method)} - ${colors.cyan(req.path)} - Status: ${res.statusCode > 299 && res.statusCode < 599 ? colors.red(res.statusCode.toString()) : colors.green(res.statusCode.toString())}`);
|
|
18
|
-
if (isInDevMode) {
|
|
19
|
-
logger.info(`[Response - Dev] Body: ${JSON.stringify(body)}`);
|
|
20
|
-
}
|
|
21
|
-
return originalSend.call(this, body);
|
|
22
|
-
};
|
|
23
|
-
next();
|
|
24
|
-
};
|
|
25
|
-
}
|